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.

FieldTypeDescription
enableAssignmentFinanceModuleboolean or null

Example true.

enableShiftFinanceModuleboolean or null

Example true.

enableAssignmentBillingboolean or null

Example true.

enableAssignmentPayablesboolean or null

Example true.

enableAssignmentReimbursementboolean or null

Example true.

enableAssignmentRateRulesboolean or null

Example true.

enableShiftBillingboolean or null

Example true.

enableShiftPayablesboolean or null

Example true.

enableShiftReimbursementboolean or null

Example true.

enableShiftRateRulesboolean or null

Example true.

enableAssignmentRequestsboolean or null

Example true.

enableShiftRequestsboolean or null

Example true.

primaryModestring or null

Example assignment.

defaultPriorityLevelobject (2 nested)
allowClientCreateRequestboolean

Example true.

allowPriorityOverrideClientboolean

Example true.

allowConsumerRequestServiceboolean

Example true.

assignmentDefaultAssignedOwnerobject (4 nested)
shiftDefaultAssignedOwnerobject (4 nested)
assignmentsPrimaryAssignmentManagerobject (4 nested)
shiftsPrimaryAssignmentManagerobject (4 nested)
allowReassignmentboolean

Example true.

fallbackManagerobject (4 nested)
reassignmentTriggerResponseTimeinteger

Example 1.

reassignmentTriggerResponseTimeUnitstring

Example Hour.

schedulerUnavailableboolean

Example true.

manualReassignmentAdminboolean

Example true.

requireVerifiedTimeDocumentationboolean

Example true.

useFidoNetworkboolean

Use the Fido network (default true): when false, the Handshakes menu is hidden. Omit to keep the stored value.

Nested fields

defaultPriorityLevel 2 fields
FieldTypeDescription
defaultPriorityLevel.idinteger

Example 1.

defaultPriorityLevel.labelstring

Example High.

assignmentDefaultAssignedOwner 4 fields
FieldTypeDescription
assignmentDefaultAssignedOwner.idstring

Example USER-MG7LWN.

assignmentDefaultAssignedOwner.imagestring

Example .

assignmentDefaultAssignedOwner.labelstring

Example Sarah Johnson (Scheduler).

assignmentDefaultAssignedOwner.subtitlestring

Example user@example.com.

shiftDefaultAssignedOwner 4 fields
FieldTypeDescription
shiftDefaultAssignedOwner.idstring

Example USER-MG7LWN.

shiftDefaultAssignedOwner.imagestring

Example .

shiftDefaultAssignedOwner.labelstring

Example Sarah Johnson (Scheduler).

shiftDefaultAssignedOwner.subtitlestring

Example user@example.com.

assignmentsPrimaryAssignmentManager 4 fields
FieldTypeDescription
assignmentsPrimaryAssignmentManager.idstring

Example USER-MG7LWN.

assignmentsPrimaryAssignmentManager.imagestring

Example .

assignmentsPrimaryAssignmentManager.labelstring

Example Sarah Johnson (Scheduler).

assignmentsPrimaryAssignmentManager.subtitlestring

Example user@example.com.

shiftsPrimaryAssignmentManager 4 fields
FieldTypeDescription
shiftsPrimaryAssignmentManager.idstring

Example USER-MG7LWN.

shiftsPrimaryAssignmentManager.imagestring

Example .

shiftsPrimaryAssignmentManager.labelstring

Example Sarah Johnson (Scheduler).

shiftsPrimaryAssignmentManager.subtitlestring

Example user@example.com.

fallbackManager 4 fields
FieldTypeDescription
fallbackManager.idstring

Example USER-MG7LWN.

fallbackManager.imagestring

Example .

fallbackManager.labelstring

Example Sarah Johnson (Scheduler).

fallbackManager.subtitlestring

Example user@example.com.

Example

JSON
{
  "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

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

JSON
{
  "success": true,
  "message": "Settings have been updated",
  "data": null
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Settings have been updated.

datastring or null
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

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 'settings_assignments_shifts: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 'settings_assignments_shifts:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

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