Company logoTrust Center Documentation
API v1 Reference/Certifications/Id

Update certification metadata

Update certification metadata including title, description, validity periods, and display settings.

PATCH
/api/v1/certifications/{id}
AuthorizationBearer <token>

In: header

Path Parameters

idstring

Certification ID

Formatuuid
title?string

Certification title

Length1 <= length
description?string

Certification description

description_markdown?string

Markdown-formatted description

issue_date?string

Issue date in YYYY-MM-DD format

Match^\d{4}-\d{2}-\d{2}$
Formatdate
expiry_date?string

Expiry date in YYYY-MM-DD format

Match^\d{4}-\d{2}-\d{2}$
Formatdate
validity_months?integer

Validity period in months

Range1 <= value
state?string

Certification state

Value in"valid" | "pending" | "expired" | "inactive"
featured?boolean

Whether certification should be featured

show_validity_period_on_card?boolean

Show validity period on card display

Response Body

const body = JSON.stringify({})

fetch("https://app.orbiqhq.com/api/v1/certifications/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  body
})
{
  "success": true,
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "title": "string",
    "description": "string",
    "description_markdown": "string",
    "category": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "title": "Compliance"
    },
    "issue_date": "2025-01-01",
    "expiry_date": "2026-01-01",
    "validity_months": 1,
    "state": "valid",
    "featured": false,
    "show_validity_period_on_card": true,
    "badge": "string",
    "file": "string",
    "date_created": "2019-08-24T14:15:22Z",
    "date_updated": "2019-08-24T14:15:22Z"
  }
}
{
  "error": "Invalid date format provided"
}
Empty
Empty
Empty

How is this guide?