API reference › Assignments › No-shows and provider status

Update provider status for an assignment

PATCH /v1/assignment-providers/{id}

Scope
assignments:edit
Roles
admin, scheduler

Updates the status of a provider for a specific assignment.

Parameters

Path parameters

NameTypeDescription
id requiredinteger

Unique identifier of the assignment

Example 1.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Request body required

FieldTypeDescription
status requiredstring

'message' sends a message to the provider instead of changing their status — see subject/message below.

One of: assigned, rebroadcast, resend_details, message, declined, interested, not_interested, canceled, pending, un_assigned. Example assigned.

subjectstring

Required when status is 'message'.

max length 255. Example Update on your assignment.

messagestring

Required when status is 'message'.

max length 5000. Example Please confirm your availability..

reasonstring or null

max length 1000. Example Provider requested time off.

notesstring or null

max length 1000. Example Internal note for the scheduler.

Example

JSON
{
  "status": "assigned",
  "subject": "Update on your assignment",
  "message": "Please confirm your availability.",
  "reason": "Provider requested time off",
  "notes": "Internal note for the scheduler"
}

Example request

Shell
curl -X PATCH "https://api.fetchfido.ai/v1/assignment-providers/{id}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"status":"assigned","subject":"Update on your assignment","message":"Please confirm your availability.","reason":"Provider requested time off","notes":"Internal note for the scheduler"}'

Try it

Responses

200 Provider status updated successfully

Provider status updated successfully

JSON
{
  "success": true,
  "message": "Provider status updated successfully",
  "data": {
    "id": "ASM-ZGJ8T2"
  }
}
Response fields (4)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Provider status updated successfully.

dataobject
data.idstring

Example ASM-ZGJ8T2.

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 '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 .

422 Validation failed

Validation error - Missing or invalid parameters

JSON
{
  "success": false,
  "message": "Validation Failed",
  "errors": {
    "providerId": [
      "The selected provider does not exist."
    ]
  }
}
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": "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..