Skip to main content
POST
Create a certification

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Body

application/json

Create a certification (learning path). After creation, add curriculum resources via the resources sub-resource, and optionally configure enrollment and assessment requirements.

Create a certification (learning path). After creation, add curriculum resources via the resources sub-resource, and optionally configure enrollment and assessment requirements.

label
string
required

Certification title

Required string length: 1 - 500
type
enum<string>
default:partner
required

Visibility: 'partner' (visible to partners) or 'internal' (internal only)

Available options:
internal,
partner
live
boolean
default:false
required

Whether the certification is published and visible

summary
string | null

Short description

duration_minutes
number | null

Expected completion time in minutes

partner_type_referral
boolean

Visible to referral partners

partner_type_reseller
boolean

Visible to reseller partners

partner_type_distributor
boolean

Visible to distributor partners

asset_uuid
string

UUID of cover image asset

assessment_is_required
boolean | null

Whether the final assessment must be passed to complete the certification

assessment_requires_curriculum_completion
boolean | null

Whether all curriculum resources must be completed before taking the assessment

prerequisite_certification_uuid
string

UUID of a certification that must be completed before this one can be started

Response

201 - application/json

Default Response

uuid
string
required
label
string
required
summary
string | null
required
live
boolean
required
type
enum<string>
required
Available options:
internal,
partner
duration_minutes
number | null
required
created_at
string
required
updated_at
string
required
asset_uuid
string | null
required
resource_count
number
required
categories
object[]
required
folders
object[]
required
partner_type_referral
boolean
required
partner_type_reseller
boolean
required
partner_type_distributor
boolean
required
resources
object[]
required
assessment_is_required
boolean | null
required
assessment_requires_curriculum_completion
boolean | null
required
prerequisite_certification_uuid
string | null
required