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

FieldTypeDescription
action requiredstring

Action to perform on client's additional locations

One of: unassign, delete, reassign. Example reassign.

clientId requiredstring

Client ID whose additional locations need to be updated

Example CLT-101.

reassignTostring or null

Target client ID to reassign locations to (required when action = reassign)

Example CLT-202.

Example

JSON
{
  "action": "reassign",
  "clientId": "CLT-101",
  "reassignTo": "CLT-202"
}

Example request

Shell
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

JSON
{
  "success": true,
  "message": "Locations reassigned successfully",
  "data": {
    "clientId": "CLT-101",
    "action": "reassign",
    "reassignTo": "CLT-202",
    "updatedLocations": 5
  }
}
Response fields (7)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Locations reassigned successfully.

dataobject
data.clientIdstring

Example CLT-101.

data.actionstring

Example reassign.

data.reassignTostring

Example CLT-202.

data.updatedLocationsinteger

Example 5.

400 Bad request

Invalid action or missing reassign target

JSON
{
  "success": false,
  "message": "Invalid action or reassignTo client ID missing when action is 'reassign'."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid action or reassignTo client ID missing when action is 'reassign'..

401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'clients:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Client not found

JSON
{
  "success": false,
  "message": "Client not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Client not found..

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Internal server error

JSON
{
  "success": false,
  "message": "An unexpected error occurred. Please try again later."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred. Please try again later..