API reference › Assignments › Cancel, change and reassign
Request cancellation of an assignment or shift (client and consumer)
POST /v1/assignment/cancel-assignment
- Scope
assignments:edit- Roles
- admin, client, scheduler, consumer
Records a client's or consumer's request to cancel an assignment or shift and notifies the currently assigned provider and the organization's admins/schedulers — it does not cancel the assignment/shift itself or calculate a fee. The organization cancels it by updating the record's status instead (POST /v1/assignments/{id} or POST /v1/shifts/{id} with the Canceled status and cancellationDetails), which is why a staff (admin, scheduler) caller receives 409 here rather than a misleading 200. Submitting again for the same assignment/shift updates the stored reason and increments a running request count rather than creating a duplicate.
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
id required | string | ID of the assignment or shift (ASG-prefixed for an assignment, otherwise a shift) to request cancellation for Example |
reasonForCancellation required | string | Reason for requesting the cancellation; sent to the organization and the assigned provider Example |
startTime | string | Optional; not read by the server Example |
startDate | string | Optional; not read by the server Example |
Example
{
"id": "ASG-J5A17Q-C1",
"reasonForCancellation": "I have another appointment at the same time",
"startTime": "06:16 AM",
"startDate": "17/10/2025"
}Example request
curl -X POST "https://api.fetchfido.ai/v1/assignment/cancel-assignment" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"id":"ASG-J5A17Q-C1","reasonForCancellation":"I have another appointment at the same time","startTime":"06:16 AM","startDate":"17/10/2025"}'Try it
Responses
200 Cancellation request recorded and the organization notified; the assignment/shift itself is unchanged until the organization cancels it
Cancellation request recorded and the organization notified; the assignment/shift itself is unchanged until the organization cancels it
{
"success": true,
"message": "Cancel assignment request submitted successfully"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
400 Bad request
Request rejected — the assignment/shift is not in a cancelable state (already completed, already canceled, not yet filled, or its end date/time has passed), or its appointment has already started or ended.
{
"success": false,
"message": "Assignment has already been canceled."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
401 Not signed in
Unauthorized - Authentication required
{
"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
Forbidden — a client or consumer who is not attached to this assignment/shift. The message is generic on purpose, so the response can't be used to tell a real id apart from one belonging to someone else.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'assignments: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 |
409 Conflict
Staff caller: the request to cancel is not recorded; cancel by updating the record status
{
"success": false,
"message": "This endpoint records a client or consumer request to cancel and does not cancel the assignment. To cancel it as staff, update the record's status to Canceled with cancellationDetails (POST /v1/assignments/{id} for an assignment, POST /v1/shifts/{id} for a shift)."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
422 Validation failed
Validation error
{
"success": false,
"message": "Validation failed",
"errors": {
"reasonForCancellation": [
"The reason for cancellation field is required."
]
}
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object |
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": "Failed to cancel assignment"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |