API reference › Service setup › Clearances
Update an existing clearance
PUT /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
| Name | Type | Description |
|---|---|---|
clearance required | integer | ID of the clearance to update. Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
name | array of object | Example |
name[].id | integer or null | |
name[].label required | string | Example |
clearanceBody | object | |
clearanceBody.id | integer or null | |
clearanceBody.label | string | Example |
requirement | string | One of: |
expirationRequired | boolean | Example |
uploadRequired | boolean | Example |
tenant_id | string or null | Example |
Example
{
"name": "Example name",
"clearanceBody": {
"id": null,
"label": "Federal Bureau"
},
"requirement": "mandatory",
"expirationRequired": false,
"uploadRequired": true,
"tenant_id": "demotenant"
}Example request
curl -X PUT "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.
{
"success": true,
"message": "Clearance updated!",
"data": {
"id": 3,
"name": "Updated Clearance Name",
"isCustom": true
}
}Response fields (6)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | 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:edit' 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 |
404 Not found
Clearance not found.
{
"success": false,
"message": "Clearance with ID 3 not found."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
422 Validation failed
Validation failed.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object | |
errors.name | array of string | |
errors.clearanceBody | array of string |
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 |