API reference › Service setup › Clearances

Update an existing clearance

PATCH /v1/clearances/{clearance}

Scope
settings_service_setup:edit
Roles
admin, scheduler

Update a clearance record by its ID with optional name changes, flags, and clearance body.

Parameters

Path parameters

NameTypeDescription
clearance requiredinteger

ID of the clearance to update.

Example 3.

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

Request body required

FieldTypeDescription
namearray of object

Example Example name.

name[].idinteger or null
name[].label requiredstring

Example Updated Clearance Name.

clearanceBodyobject
clearanceBody.idinteger or null
clearanceBody.labelstring

Example Federal Bureau.

requirementstring

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

expirationRequiredboolean

Example false.

uploadRequiredboolean

Example true.

tenant_idstring or null

Example demotenant.

Example

JSON
{
  "name": "Example name",
  "clearanceBody": {
    "id": null,
    "label": "Federal Bureau"
  },
  "requirement": "mandatory",
  "expirationRequired": false,
  "uploadRequired": true,
  "tenant_id": "demotenant"
}

Example request

Shell
curl -X PATCH "https://api.fetchfido.ai/v1/clearances/{clearance}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example name","clearanceBody":{"id":null,"label":"Federal Bureau"},"requirement":"mandatory","expirationRequired":false,"uploadRequired":true,"tenant_id":"demotenant"}'

Try it

Responses

200 Clearance updated successfully

Clearance updated successfully.

JSON
{
  "success": true,
  "message": "Clearance updated!",
  "data": {
    "id": 3,
    "name": "Updated Clearance Name",
    "isCustom": true
  }
}
Response fields (6)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Clearance updated!.

dataobject
data.idinteger

Example 3.

data.namestring

Example Updated Clearance Name.

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

Clearance not found.

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

Example false.

messagestring

Example Clearance with ID 3 not found..

422 Validation failed

Validation failed.

JSON
{
  "success": false,
  "message": "Unable to save. Please check the highlighted fields.",
  "errors": {
    "name": [
      "Clearance name is required."
    ],
    "clearanceBody": [
      "Clearance Body name is already taken."
    ]
  }
}
Response fields (5)
FieldTypeDescription
successboolean

Example false.

messagestring

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

errorsobject
errors.namearray of string
errors.clearanceBodyarray of string
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!.