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

FieldTypeDescription
serviceBodyobject
serviceBody.idinteger or null
serviceBody.label requiredstring

Example Interpreter Services Board.

name requiredarray of object

min items 1.

name[].idinteger
name[].label requiredstring

Example DOJ Clearance.

requirement requiredstring

One of: required, preferred, optional. Example preferred.

notesstring

Example example notes.

Example

JSON
{
  "serviceBody": {
    "id": null,
    "label": "Interpreter Services Board"
  },
  "name": [
    {
      "id": null,
      "label": "DOJ Clearance"
    }
  ],
  "requirement": "preferred",
  "notes": "example notes"
}

Example request

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

JSON
{
  "success": true,
  "message": "Specializations created!",
  "data": [
    {
      "id": 12,
      "name": "DOJ Clearance",
      "isCustom": true
    }
  ]
}
Response fields (6)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Specializations created!.

dataarray of object
data[].idinteger

Example 12.

data[].namestring

Example DOJ Clearance.

data[].isCustomboolean

Example true.

401 Not signed in

Missing, invalid or expired API key.

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_service_setup:write' 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_service_setup:write' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation failed.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Unable to save. Please check the highlighted fields..

errorsobject
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

Server error.

JSON
{
  "success": false,
  "message": "Something went wrong!"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.