Certificate
The certificate is the template printed when a learner earns a certificate on a course. These routes stay at /players/{id}/certificate.
Overview
Get Certificate returns the unpublished template, or the live template when nothing is unpublished. The response has no preview_url. When no template has been saved, the response is the starting values and that read does not store a template.
Update Certificate writes only the keys you send. content merges the same way. The first successful update stores the template. The write does not publish: on a published course it saves pending edits. The response is the full template plus preview_url. Visitors see the change when you publish. See Draft, preview, and publish and Updates.
include=certificate on Get Course returns the same template. Leave certificate out of include and the key stays null.
The same template can be set on Create Course and Update Course. Those are draft writes too.
A course id that is missing or not a UUID returns 404. See Identifiers.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /players/{id}/certificate | Get the certificate template |
| PATCH | /players/{id}/certificate | Update the certificate template |
Certificate Object
The certificate template for the course. Get Certificate returns the starting values below when no template has been saved, and that read does not store one. The first successful update stores the template.
| Field | Type | Description |
|---|---|---|
is_active | boolean|null | Whether the template is active. null clears it. Starts null. |
progress_threshold_percent | integer | Progress required before the certificate can be issued, from 0 to 100. 0 is valid. Starts at 80. |
available_from | string|null | First day the certificate can be issued, YYYY-MM-DD. null clears it. Starts null. |
template | string | light-image, light-waves, light-stripes, dark-stripes, dark-dots, or custom. Starts as light-image. |
content | object | Content Object |
Content Object
Every key is present. null clears that key.
| Field | Type | Description |
|---|---|---|
course_name | string|null | Name printed on the certificate. Starts null. |
course_description | string|null | Description printed on the certificate. Starts null. |
course_image_url | string|null | Course image address. Starts null. |
background_image_url | string|null | Background image address. Starts null. |
color | string|null | Accent color. Starts null. |
text_color | string|null | Text color. Starts null. |