API reference › Assignment and shift rules › Assignment shift settings
Create or update assignments and shifts settings
POST /v1/settings/assignment-shift-settings
- Scope
settings_assignments_shifts:edit- Roles
- admin, scheduler
Creates or updates the assignments and shifts settings for an organization, including core structure and finances
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
29 top-level fields; 6 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
enableAssignmentFinanceModule | boolean or null | Example |
enableShiftFinanceModule | boolean or null | Example |
enableAssignmentBilling | boolean or null | Example |
enableAssignmentPayables | boolean or null | Example |
enableAssignmentReimbursement | boolean or null | Example |
enableAssignmentRateRules | boolean or null | Example |
enableShiftBilling | boolean or null | Example |
enableShiftPayables | boolean or null | Example |
enableShiftReimbursement | boolean or null | Example |
enableShiftRateRules | boolean or null | Example |
enableAssignmentRequests | boolean or null | Example |
enableShiftRequests | boolean or null | Example |
primaryMode | string or null | Example |
defaultPriorityLevel | object (2 nested) | |
allowClientCreateRequest | boolean | Example |
allowPriorityOverrideClient | boolean | Example |
allowConsumerRequestService | boolean | Example |
assignmentDefaultAssignedOwner | object (4 nested) | |
shiftDefaultAssignedOwner | object (4 nested) | |
assignmentsPrimaryAssignmentManager | object (4 nested) | |
shiftsPrimaryAssignmentManager | object (4 nested) | |
allowReassignment | boolean | Example |
fallbackManager | object (4 nested) | |
reassignmentTriggerResponseTime | integer | Example |
reassignmentTriggerResponseTimeUnit | string | Example |
schedulerUnavailable | boolean | Example |
manualReassignmentAdmin | boolean | Example |
requireVerifiedTimeDocumentation | boolean | Example |
useFidoNetwork | boolean | Use the Fido network (default true): when false, the Handshakes menu is hidden. Omit to keep the stored value. |
Nested fields
defaultPriorityLevel 2 fields
| Field | Type | Description |
|---|---|---|
defaultPriorityLevel.id | integer | Example |
defaultPriorityLevel.label | string | Example |
assignmentDefaultAssignedOwner 4 fields
| Field | Type | Description |
|---|---|---|
assignmentDefaultAssignedOwner.id | string | Example |
assignmentDefaultAssignedOwner.image | string | Example |
assignmentDefaultAssignedOwner.label | string | Example |
assignmentDefaultAssignedOwner.subtitle | string | Example |
shiftDefaultAssignedOwner 4 fields
| Field | Type | Description |
|---|---|---|
shiftDefaultAssignedOwner.id | string | Example |
shiftDefaultAssignedOwner.image | string | Example |
shiftDefaultAssignedOwner.label | string | Example |
shiftDefaultAssignedOwner.subtitle | string | Example |
assignmentsPrimaryAssignmentManager 4 fields
| Field | Type | Description |
|---|---|---|
assignmentsPrimaryAssignmentManager.id | string | Example |
assignmentsPrimaryAssignmentManager.image | string | Example |
assignmentsPrimaryAssignmentManager.label | string | Example |
assignmentsPrimaryAssignmentManager.subtitle | string | Example |
shiftsPrimaryAssignmentManager 4 fields
| Field | Type | Description |
|---|---|---|
shiftsPrimaryAssignmentManager.id | string | Example |
shiftsPrimaryAssignmentManager.image | string | Example |
shiftsPrimaryAssignmentManager.label | string | Example |
shiftsPrimaryAssignmentManager.subtitle | string | Example |
fallbackManager 4 fields
| Field | Type | Description |
|---|---|---|
fallbackManager.id | string | Example |
fallbackManager.image | string | Example |
fallbackManager.label | string | Example |
fallbackManager.subtitle | string | Example |
Example
{
"enableAssignmentFinanceModule": true,
"enableShiftFinanceModule": true,
"enableAssignmentBilling": true,
"enableAssignmentPayables": true,
"enableAssignmentReimbursement": true,
"enableAssignmentRateRules": true,
"enableShiftBilling": true,
"enableShiftPayables": true,
"enableShiftReimbursement": true,
"enableShiftRateRules": true,
"enableAssignmentRequests": true,
"enableShiftRequests": true,
"primaryMode": "assignment",
"defaultPriorityLevel": {
"id": 1,
"label": "High"
},
"allowClientCreateRequest": true,
"allowPriorityOverrideClient": true,
"allowConsumerRequestService": true,
"assignmentDefaultAssignedOwner": {
"id": "USER-MG7LWN",
"image": "",
"label": "Sarah Johnson (Scheduler)",
"subtitle": "user@example.com"
},
"shiftDefaultAssignedOwner": {
"id": "USER-MG7LWN",
"image": "",
"label": "Sarah Johnson (Scheduler)",
"subtitle": "user@example.com"
},
"assignmentsPrimaryAssignmentManager": {
"id": "USER-MG7LWN",
"image": "",
"label": "Sarah Johnson (Scheduler)",
"subtitle": "user@example.com"
},
"shiftsPrimaryAssignmentManager": {
"id": "USER-MG7LWN",
"image": "",
"label": "Sarah Johnson (Scheduler)",
"subtitle": "user@example.com"
},
"allowReassignment": true,
"fallbackManager": {
"id": "USER-MG7LWN",
"image": "",
"label": "Sarah Johnson (Scheduler)",
"subtitle": "user@example.com"
},
"reassignmentTriggerResponseTime": 1,
"reassignmentTriggerResponseTimeUnit": "Hour",
"schedulerUnavailable": true,
"manualReassignmentAdmin": true,
"requireVerifiedTimeDocumentation": true,
"useFidoNetwork": true
}Example request
curl -X POST "https://api.fetchfido.ai/v1/settings/assignment-shift-settings" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"enableAssignmentFinanceModule":true,"enableShiftFinanceModule":true,"enableAssignmentBilling":true,"enableAssignmentPayables":true,"enableAssignmentReimbursement":true,"enableAssignmentRateRules":true,"enableShiftBilling":true,"enableShiftPayables":true,"enableShiftReimbursement":true,"enableShiftRateRules":true,"enableAssignmentRequests":true,"enableShiftRequests":true,"primaryMode":"assignment","defaultPriorityLevel":{"id":1,"label":"High"},"allowClientCreateRequest":true,"allowPriorityOverrideClient":true,"allowConsumerRequestService":true,"assignmentDefaultAssignedOwner":{"id":"USER-MG7LWN","image":"","label":"Sarah Johnson (Scheduler)","subtitle":"user@example.com"},"shiftDefaultAssignedOwner":{"id":"USER-MG7LWN","image":"","label":"Sarah Johnson (Scheduler)","subtitle":"user@example.com"},"assignmentsPrimaryAssignmentManager":{"id":"USER-MG7LWN","image":"","label":"Sarah Johnson (Scheduler)","subtitle":"user@example.com"},"shiftsPrimaryAssignmentManager":{"id":"USER-MG7LWN","image":"","label":"Sarah Johnson (Scheduler)","subtitle":"user@example.com"},"allowReassignment":true,"fallbackManager":{"id":"USER-MG7LWN","image":"","label":"Sarah Johnson (Scheduler)","subtitle":"user@example.com"},"reassignmentTriggerResponseTime":1,"reassignmentTriggerResponseTimeUnit":"Hour","schedulerUnavailable":true,"manualReassignmentAdmin":true,"requireVerifiedTimeDocumentation":true,"useFidoNetwork":true}'Try it
Responses
200 Settings have been updated
Settings have been updated.
{
"success": true,
"message": "Settings have been updated",
"data": null
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | string or null |
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
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 'settings_assignments_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 |
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 |