API reference › Team › Schedulers
Create a new scheduler
POST /v1/scheduler
- Scope
team:write- Roles
- admin, scheduler
Creates a new scheduler
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
27 top-level fields; 5 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
name required | string | max length 255. Example |
email required | string (email) | Unique among this organization's users. max length 255. Example |
jobRole required | string | Example |
status required | object (2 nested) | |
isPublished | boolean or null | Example |
role | object or null (2 nested) | The staff role the user holds: the Scheduler, one of the organization's custom roles (a role with is_custom true) or Admin. Portal roles are refused (422). Only an administrator can send the Admin role (403, code |
roles | array of object or null (3 nested) | |
description | string or null | min length 5, max length 2000. |
logo | string (binary) or null | jpg, jpeg or png, max 2 MB. |
countryCode | string or null | max length 5. Example |
phone | string or null | Required unless videoPhone is sent, and when receiveSms is true. max length 20. Example |
phoneType | string or null | One of: |
phoneExtension | string or null | max length 10. |
videoPhoneCountryCode | string or null | max length 5. Example |
videoPhone | string or null | max length 20. |
dateOfBirth | string (date) or null | |
gender | object or null (2 nested) | Required when the scheduler is published. |
addressLine1 | string or null | |
addressLine2 | string or null | |
city | string or null | |
state | object (2 nested) | |
postalCode | string or null | Example |
receiveEmail | boolean or null | Notification preference. |
receiveSms | boolean or null | Notification preference. |
receiveInApp | boolean or null | Notification preference. |
notifyOrgWide | boolean or null | Receive notifications for every work item in the organization, not only the ones the scheduler owns. |
defaultTimezone | string or null | Example |
Nested fields
status 2 fields
| Field | Type | Description |
|---|---|---|
status.id | integer or string | Example |
status.label | string or null | Example |
role 2 fields
| Field | Type | Description |
|---|---|---|
role.id | integer | Example |
role.label | string or null | Example |
roles 3 fields
| Field | Type | Description |
|---|---|---|
roles[].id | integer or null | Role id. Resolved from slug when omitted. Example |
roles[].slug | string | Example |
roles[].enabled | boolean | Example |
gender 2 fields
| Field | Type | Description |
|---|---|---|
gender.id | integer or string | Example |
gender.label | string or null | Example |
state 2 fields
| Field | Type | Description |
|---|---|---|
state.id | integer or string | Example |
state.label | string or null | Example |
Example
{
"name": "Jordan Lee",
"email": "jordan@example.test",
"jobRole": "Lead Scheduler",
"status": {
"id": 1,
"label": "Example"
},
"isPublished": true,
"role": {
"id": 7,
"label": "Coordinator"
},
"roles": [
{
"id": 3,
"slug": "consumer",
"enabled": true
}
],
"description": "string",
"logo": "string",
"countryCode": "+1",
"phone": "2025550101",
"phoneType": "sms_and_voice",
"phoneExtension": "string",
"videoPhoneCountryCode": "+1",
"videoPhone": "string",
"dateOfBirth": "string",
"gender": {
"id": 1,
"label": "Example"
},
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": {
"id": 1,
"label": "Example"
},
"postalCode": "78759",
"receiveEmail": true,
"receiveSms": true,
"receiveInApp": true,
"notifyOrgWide": true,
"defaultTimezone": "America/Chicago"
}Example request
curl -X POST "https://api.fetchfido.ai/v1/scheduler" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"name":"Jordan Lee","email":"jordan@example.test","jobRole":"Lead Scheduler","status":{"id":1,"label":"Example"},"isPublished":true,"role":{"id":7,"label":"Coordinator"},"roles":[{"id":3,"slug":"consumer","enabled":true}],"description":"string","logo":"string","countryCode":"+1","phone":"2025550101","phoneType":"sms_and_voice","phoneExtension":"string","videoPhoneCountryCode":"+1","videoPhone":"string","dateOfBirth":"string","gender":{"id":1,"label":"Example"},"addressLine1":"string","addressLine2":"string","city":"string","state":{"id":1,"label":"Example"},"postalCode":"78759","receiveEmail":true,"receiveSms":true,"receiveInApp":true,"notifyOrgWide":true,"defaultTimezone":"America/Chicago"}'Try it
Responses
201 Scheduler created successfully
Scheduler created successfully
{
"success": true,
"message": "Scheduler created successfully",
"data": {
"id": "USR-ABC123"
}
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | string | Example |
401 Not signed in
Unauthorized
{
"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 'team:write' 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
{
"success": false,
"message": "The email you entered is already in use.",
"errors": {
"email": [
"The email has already been taken."
]
}
}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."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |