GuidesRecipesAPI ReferenceChangelog
Log In
API Reference

Edit a certificate outline

patch
https://app.360learning.com/api/v2/certificate-outlines/
šŸ”‘

Required OAuth scope: certificateOutlines:write.

Edits specific fields of an existing certificate outline. Fields not included in the request payload remain unchanged.

Path Params
string
required
^[a-fA-F0-9]{24}$

The unique ID of the certificate outline.

Body Params
string
length ā‰„ 1

The title of the certificate outline.

string
^[a-fA-F0-9]{24}$

The unique ID of the group this outline belongs to.

string
length ā‰„ 1

The content of the certificate outline. Can contain tags which will dynamically be replaced when delivering a certificate. Available tags are: [person_first_name], [person_last_name], [person_email], [person_organization], [authenticity_verification_url], [credits_acquired], [delivery_date], [path_session_title], [path_title], [reference_number], [score_reached], [start_date], [time_spent], [validity_period].

string | null

A wording to display the authenticity verification URL. If set, it needs to contain [authenticity_verification_url] tag.

string | null
^[a-fA-F0-9]{24}$

The media unique ID of the background image for this outline.

string | null
^[a-fA-F0-9]{24}$

The media unique ID of the logo to display at the top of the certificate.

string | null

A wording to display the reference number. If set, it needs to contain [reference_number] tag.

string | null

The subtitle of the certificate outline.

integer | null
ā‰„ 1

Number of months of validity of the certificate.

string | null

A wording to display the validity period. If set, it needs to contain [validity_period] tag.

Headers
string
enum
required

The version of the API.

Allowed:
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoadingā€¦
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?