API reference › Clients › Locations
Manage client location reassignment
POST /v1/reassign-client-locations
- Scope
clients:edit- Roles
- admin, scheduler
Allows reassigning, unassigning, or deleting additional client locations based on selected action.
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
action required | string | Action to perform on client's additional locations One of: |
clientId required | string | Client ID whose additional locations need to be updated Example |
reassignTo | string or null | Target client ID to reassign locations to (required when action = reassign) Example |
Example
{
"action": "reassign",
"clientId": "CLT-101",
"reassignTo": "CLT-202"
}Example request
curl -X POST "https://api.fetchfido.ai/v1/reassign-client-locations" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"action":"reassign","clientId":"CLT-101","reassignTo":"CLT-202"}'Try it
Responses
200 Locations reassigned or updated successfully
Locations reassigned or updated successfully
{
"success": true,
"message": "Locations reassigned successfully",
"data": {
"clientId": "CLT-101",
"action": "reassign",
"reassignTo": "CLT-202",
"updatedLocations": 5
}
}Response fields (7)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.clientId | string | Example |
data.action | string | Example |
data.reassignTo | string | Example |
data.updatedLocations | integer | Example |
400 Bad request
Invalid action or missing reassign target
{
"success": false,
"message": "Invalid action or reassignTo client ID missing when action is 'reassign'."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"success": false,
"message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
"errors": null,
"code": "API_KEY_MISSING"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'clients:edit' scope.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
404 Not found
Client not found
{
"success": false,
"message": "Client not found."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"success": false,
"message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
"errors": null,
"code": "RATE_LIMITED"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Internal server error
{
"success": false,
"message": "An unexpected error occurred. Please try again later."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |