API reference › Service setup › Certifications

Update a certification

PATCH /v1/certifications/{certification}

Scope
settings_service_setup:edit
Roles
admin, scheduler

Update an existing certification by ID.

Parameters

Path parameters

NameTypeDescription
certification requiredinteger

ID of the certification to update.

Example 3.

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

Request body required

FieldTypeDescription
namestring

Example Updated Certification.

requirementstring

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

expirationRequiredboolean

Example true.

uploadRequiredboolean

Example false.

certificationBodystring or null

Renames the certification body this certification belongs to.

Example Registry Board.

levelinteger or null

Moves the certification within its body; null puts it at the next free level.

min 1. Example 2.

Example

JSON
{
  "name": "Updated Certification",
  "requirement": "required",
  "expirationRequired": true,
  "uploadRequired": false,
  "certificationBody": "Registry Board",
  "level": 2
}

Example request

Shell
curl -X PATCH "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

JSON
{
  "success": true,
  "message": "Certification updated!",
  "data": {
    "id": 3,
    "label": "Updated Certification",
    "value": 3,
    "isCustom": true,
    "serviceId": 1
  }
}
Response fields (8)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Certification updated!.

dataobject
data.idinteger

Example 3.

data.labelstring

Example Updated Certification.

data.valueinteger

Example 3.

data.isCustomboolean

Example true.

data.serviceIdinteger

Example 1.

400 Bad request

Validation failed

JSON
{
  "success": false,
  "message": "Unable to save. Please check the highlighted fields.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

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

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

Certification not found

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

Example false.

messagestring

Example Certification with ID 3 not found..

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