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

FieldTypeDescription
id requiredstring

ID of the assignment or shift (ASG-prefixed for an assignment, otherwise a shift) to request cancellation for

Example ASG-J5A17Q-C1.

reasonForCancellation requiredstring

Reason for requesting the cancellation; sent to the organization and the assigned provider

Example I have another appointment at the same time.

startTimestring

Optional; not read by the server

Example 06:16 AM.

startDatestring

Optional; not read by the server

Example 17/10/2025.

Example

JSON
{
  "id": "ASG-J5A17Q-C1",
  "reasonForCancellation": "I have another appointment at the same time",
  "startTime": "06:16 AM",
  "startDate": "17/10/2025"
}

Example request

Shell
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

JSON
{
  "success": true,
  "message": "Cancel assignment request submitted successfully"
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Cancel assignment request submitted successfully.

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.

JSON
{
  "success": false,
  "message": "Assignment has already been canceled."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Assignment has already been canceled..

401 Not signed in

Unauthorized - Authentication required

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

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.

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

Example false.

messagestring

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

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

409 Conflict

Staff caller: the request to cancel is not recorded; cancel by updating the record status

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

Example false.

messagestring

Example 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)..

422 Validation failed

Validation error

JSON
{
  "success": false,
  "message": "Validation failed",
  "errors": {
    "reasonForCancellation": [
      "The reason for cancellation field is required."
    ]
  }
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Validation failed.

errorsobject
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": "Failed to cancel assignment"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Failed to cancel assignment.