API reference › Service setup › Certifications
Update a certification
PUT /v1/certifications/{certification}
- Scope
settings_service_setup:edit- Roles
- admin, scheduler
Update an existing certification by ID.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
certification required | integer | ID of the certification to update. Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
name | string | Example |
requirement | string | One of: |
expirationRequired | boolean | Example |
uploadRequired | boolean | Example |
certificationBody | string or null | Renames the certification body this certification belongs to. Example |
level | integer or null | Moves the certification within its body; null puts it at the next free level. min 1. Example |
Example
{
"name": "Updated Certification",
"requirement": "required",
"expirationRequired": true,
"uploadRequired": false,
"certificationBody": "Registry Board",
"level": 2
}Example request
curl -X PUT "https://api.fetchfido.ai/v1/certifications/{certification}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"name":"Updated Certification","requirement":"required","expirationRequired":true,"uploadRequired":false,"certificationBody":"Registry Board","level":2}'Try it
Responses
200 Certification updated successfully
Certification updated successfully
{
"success": true,
"message": "Certification updated!",
"data": {
"id": 3,
"label": "Updated Certification",
"value": 3,
"isCustom": true,
"serviceId": 1
}
}Response fields (8)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | integer | Example |
data.label | string | Example |
data.value | integer | Example |
data.isCustom | boolean | Example |
data.serviceId | integer | Example |
400 Bad request
Validation failed
{
"success": false,
"message": "Unable to save. Please check the highlighted fields.",
"errors": {
"name": [
"The name field is required."
]
}
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object | |
errors.name | array of string |
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
Certification not found
{
"success": false,
"message": "Certification with ID 3 not found."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
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 |