Sign in

v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Certificate Outlines

Create certificate outline

🔑

Required OAuth scope: certificateOutlines:write.

Creates a new certificate outline in your platform.

post/api/v2/certificate-outlines

Headers

360-api-version'v2.0' required

The version of the API.

Request body

titlestring required

The title of the certificate outline.

groupIdstring ObjectId required

The unique ID of the group this outline belongs to.

bodyHtmlstring required

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

authenticityVerificationUrlWordingstring

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

backgroundImageIdstring ObjectId

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

logoImageIdstring ObjectId

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

referenceNumberWordingstring

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

subtitlestring

The subtitle of the certificate outline.

validityPeriodinteger

Number of months of validity of the certificate.

validityPeriodWordingstring

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

Example request

{
  "title": "Certificate of Completion",
  "groupId": "507f1f77bcf86cd799439011",
  "bodyHtml": "<p>This certificate ensures [person_first_name] [person_last_name] received a certificate on [path_title] <br> This certificate was delivered by Training Organization <br> Contact: training@organization.com </p>",
  "authenticityVerificationUrlWording": "You can also find this document on the Internet at the following address: [authenticity_verification_url]",
  "backgroundImageId": "507f1f77bcf86cd799439011",
  "logoImageId": "507f1f77bcf86cd799439011",
  "referenceNumberWording": "Reference number: [reference_number]",
  "subtitle": "Certificate topic",
  "validityPeriodWording": "This certificate is valid for a period of [validity_period] months"
}

Response

Returns newly created certificate outline.

titlestring required

The title of the certificate outline.

groupIdstring ObjectId required

The unique ID of the group this outline belongs to.

_idstring ObjectId required

The unique ID of the certificate outline.

createdAtstring date-time required

The date and time when the certificate outline was created, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

Example response

{
  "title": "Certificate of Completion",
  "groupId": "507f1f77bcf86cd799439011",
  "_id": "507f1f77bcf86cd799439011"
}