Skip to main content
POST
Enroll a user in a certification

Authorizations

Authorization
string
header
required

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

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

Enroll a user in this certification. Creates an enrollment with status 'enrolled' and 0% progress.

Enroll a user in this certification. Creates an enrollment with status 'enrolled' and 0% progress.

user_uuid
string
required

UUID of the user to enroll

partnership_uuid
string

UUID of the partnership context for this enrollment. Required for partner users.

Response

201 - application/json

A user's enrollment and progress in a certification.

A user's enrollment and progress in a certification.

uuid
string
required
user_uuid
string
required
user_email
string
required
status
enum<string>
required

enrolled → in_progress → completed or failed

Available options:
enrolled,
in_progress,
completed,
failed
progress_percentage
number
required

Completion progress (0-100)

enrolled_at
string
required
started_at
string | null
required
completed_at
string | null
required
assessment_best_score
number | null
required

Highest assessment score (0-100), or null if not attempted

assessment_passed
boolean | null
required

Whether the user passed the assessment