Attach a certificate to a video

post

https://api.mindstamp.com/api/v1/videos/{id}/certificates

Attach a certificate design to a video with the rules for this video. The response has the click_action and click_value that give the certificate from a button, a hotspot, or a question answer. Set end_screen to give it on the end screen. A design can be on a video one time: a second request for the same design changes the existing one and answers 200. Attaching does not count toward the certificate quota.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Video ID or token.

Body Params

certificate_id

uuid

required

Certificate design ID from GET /certificates.

button_text

string

Text of the end screen certificate button. New attachments start with "Get Certificate".

min_completion

integer | null

0 to 100

The viewer must watch at least this percent of the video. 0 or null removes the rule.

min_score

integer | null

0 to 100

The viewer's score must be at least this percent. A viewer with no scored answers does not pass. 0 or null removes the rule.

require_known_viewer

boolean

The viewer must give a name, email, phone number, or custom ID. When this is the only missing rule, the certificate dialog asks for a name. Default false.

ineligible_behavior

string

enum

What the end screen certificate button does before the viewer meets the rules. show_reason: the button works, and the dialog tells the viewer what is missing. disabled: the button shows but does not work. hide_button: the button stays hidden. Default show_reason.

Allowed:

enabled

boolean

false keeps the settings but stops issuing. Default true.

field_overrides

object

Text for this video only, keyed by the id of a text field of the design: {"course": {"text": "Final round"}}. Each value takes text and fallback.

end_screen

boolean

true gives this certificate on the end screen. false removes it from the end screen. Omit to leave the end screen as it is.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

401

Not Authorized

500

Error

503

Rate Limit Exceeded

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200The design was already on the video. Its settings changed.

201Created

404Certificates are not enabled, or the record is not in this organization

422The certificate is not in this organization, or a value is not valid