API Guide

Update the certificate on a video

patch
https://api.mindstamp.com/api/v1/videos//certificates/

Change the rules. Send only the fields to change.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Video ID or token.

string
required

ID from GET /videos/{id}/certificates.

Body Params
string

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

integer | null
0 to 100

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

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.

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.

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:
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.

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
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

401

Not Authorized

500

Error

503

Rate Limit Exceeded

Updated about 22 hours ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated about 22 hours ago

Did this page help you?