Skip to content

Update a certification

Credentials module

PATCH/certifications/{id}certifications.update

A certification type, linked to canon compliance tags. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requires the capability people.role.write.
  • OAuth scopes: people.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

certifications.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the certification.

Request body: CertificationUpdate

certifications.update: CertificationUpdate
FieldTypeRequiredDescription
namestringNoCertification name.Constraints: length 1 to 300
issuing_bodystringNoBody that issues the certification.Constraints: length 1 to 300
{
  "name": "OSHA 10",
  "issuing_body": "OSHA"
}

Response 200: Certification

certifications.update: Certification
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the certification.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
namestringYesCertification name.Constraints: length 1 to 300
issuing_bodystringYesBody that issues the certification.Constraints: length 1 to 300
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "OSHA 10",
  "issuing_body": "OSHA"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/certifications/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"name":"OSHA 10","issuing_body":"OSHA"}'
const { data, etag } = await xos.certifications.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "name": "OSHA 10",
    "issuing_body": "OSHA"
  }, { ifMatch: etag });
response = xos.certifications.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "OSHA 10", "issuing_body": "OSHA"}, if_match=etag)
xos certifications update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"OSHA 10","issuing_body":"OSHA"}' --if-match auto