Create certificate outline

post

https://app.360learning.com/api/v2/certificate-outlines

Required OAuth scope: certificateOutlines:write.

Creates a new certificate outline in your platform.

Body Params

title

string

required

length ≥ 1

The title of the certificate outline.

groupId

string

required

The unique ID of the group this outline belongs to.

bodyHtml

string

required

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

authenticityVerificationUrlWording

string

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

backgroundImageId

string

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

logoImageId

string

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

referenceNumberWording

string

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

subtitle

string

length ≥ 1

The subtitle of the certificate outline.

validityPeriod

integer

≥ 1

Number of months of validity of the certificate.

validityPeriodWording

string

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

Headers

360-api-version

string

enum

required

The version of the API.

Allowed:

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

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

application/json

200Returns newly created certificate outline.

400The server cannot or will not process the request due to something that is perceived to be a client error.

401The given access token is either missing, invalid, has expired, or has been revoked.

403The given access token does not have the required OAuth scope to execute the request.

404The given groupId does not correspond to any existing group.

429The client has sent too many requests in a short amount of time.