Update certification metadata

Update certification metadata including title, description, validity periods, and display settings. Browse request parameters, authentication requirements,…

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

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

title?string

Certification title

Length1 <= length

slug?string

URL-friendly certification identifier

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"
"expired"

featured?boolean

Whether certification should be featured

show_validity_period_on_card?boolean

Show validity period on card display

variant_options?array<>

Variant option IDs to assign to this item (default locale only). Replaces all existing assignments. If the content update succeeds but the assignment sync fails, the response is still 200 and includes variant_assignments_warning: variant_assignments_failed while omitting variant_options; an assignment-only update that fails to sync returns 500 with error variant_assignments_failed. On success the response echoes the assigned option IDs as variant_options.

Response Body

`application/json`

curl -X PATCH "https://app.orbiqhq.com/api/v1/certifications/{id}" \  -H "Authorization: Bearer $ACCESS_TOKEN" \  -H "Content-Type: application/json"

{  "success": true,  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "title": "string",    "slug": "string",    "description": "string",    "description_markdown": "string",    "category": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "title": "string"    },    "issue_date": "2019-08-24",    "expiry_date": "2019-08-24",    "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"  }}

How is this guide?

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401

404

409application/json

500

`application/json`

`application/json`

`application/json`