API reference › Service setup › Specializations

Update an existing specialization

PATCH /v1/specializations/{specialization}

Scope
settings_service_setup:edit
Roles
admin, scheduler

Update an existing specialization by ID with optional service body, requirement, and notes.

Parameters

Path parameters

NameTypeDescription
specialization requiredinteger

ID of the specialization to update.

Example 5.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Request body required

FieldTypeDescription
namestring

Example Example Updated.

serviceBodyobject
serviceBody.idinteger or null
serviceBody.label requiredstring

Example sdsad.

requirementstring

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

notesstring

Example ABC.

Example

JSON
{
  "name": "Example Updated",
  "serviceBody": {
    "id": null,
    "label": "sdsad"
  },
  "requirement": "preferred",
  "notes": "ABC"
}

Example request

Shell
curl -X PATCH "https://api.fetchfido.ai/v1/specializations/{specialization}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example Updated","serviceBody":{"id":null,"label":"sdsad"},"requirement":"preferred","notes":"ABC"}'

Try it

Responses

200 Specialization updated successfully

Specialization updated successfully.

JSON
{
  "success": true,
  "message": "Specialization updated!",
  "data": {
    "id": 5,
    "name": "Example Updated",
    "isCustom": true
  }
}
Response fields (6)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Specialization updated!.

dataobject
data.idinteger

Example 5.

data.namestring

Example Example Updated.

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

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Specialization not found.

JSON
{
  "success": false,
  "message": "Specialization with ID 5 not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Specialization with ID 5 not found..

422 Validation failed

Validation failed.

JSON
{
  "success": false,
  "message": "Unable to save. Please check the highlighted fields.",
  "errors": {
    "name": [
      "The name field is required."
    ],
    "serviceBody.label": [
      "The service body label has already been taken."
    ]
  }
}
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!.