API reference › Service setup › Specializations
Create one or more specializations
POST /v1/specializations
- Scope
settings_service_setup:write- Roles
- admin, scheduler
Create a new set of specializations with optional service body, requirement, and notes flag. Supports custom or predefined entries.
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
serviceBody | object | |
serviceBody.id | integer or null | |
serviceBody.label required | string | Example |
name required | array of object | min items 1. |
name[].id | integer | |
name[].label required | string | Example |
requirement required | string | One of: |
notes | string | Example |
Example
{
"serviceBody": {
"id": null,
"label": "Interpreter Services Board"
},
"name": [
{
"id": null,
"label": "DOJ Clearance"
}
],
"requirement": "preferred",
"notes": "example notes"
}Example request
curl -X POST "https://api.fetchfido.ai/v1/specializations" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"serviceBody":{"id":null,"label":"Interpreter Services Board"},"name":[{"id":null,"label":"DOJ Clearance"}],"requirement":"preferred","notes":"example notes"}'Try it
Responses
201 Specializations created successfully
Specializations created successfully.
{
"success": true,
"message": "Specializations created!",
"data": [
{
"id": 12,
"name": "DOJ Clearance",
"isCustom": true
}
]
}Response fields (6)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | array of object | |
data[].id | integer | Example |
data[].name | string | Example |
data[].isCustom | boolean | 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 'settings_service_setup: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 failed.
{
"success": false,
"message": "Unable to save. Please check the highlighted fields.",
"errors": {
"name": [
"Specialization name is required."
],
"serviceBody": [
"Service Body is required."
]
}
}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
Server error.
{
"success": false,
"message": "Something went wrong!"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |