API reference › Shifts › No-shows and provider status
Update provider status for an shift
PATCH /v1/shift-providers/{id}
- Scope
shifts:edit- Roles
- admin, scheduler
Updates the status of a provider for a specific shift.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
id required | integer | Unique identifier of the shift Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
status required | string | 'message' sends a message to the provider instead of changing their status — see subject/message below. One of: |
subject | string | Required when status is 'message'. max length 255. Example |
message | string | Required when status is 'message'. max length 5000. Example |
reason | string or null | max length 1000. Example |
notes | string or null | max length 1000. Example |
Example
{
"status": "assigned",
"subject": "Update on your shift",
"message": "Please confirm your availability.",
"reason": "Provider requested time off",
"notes": "Internal note for the scheduler"
}Example request
curl -X PATCH "https://api.fetchfido.ai/v1/shift-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 shift","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
{
"success": true,
"message": "Provider status updated successfully",
"data": {
"id": "ASM-ZGJ8T2"
}
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | 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 'shifts: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 |
422 Validation failed
Validation error - Missing or invalid parameters
{
"success": false,
"message": "Validation Failed",
"errors": {
"providerId": [
"The selected provider does not exist."
]
}
}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": "An unexpected error occurred. Please try again later."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |