Program Templates

The Program Template Object provides functionality for templates to be made and automatically delivered once a set of rules based on type is met. This enables the client to know what is happening with their order and if anything is needed of them.

This object contains the follwing attributes:

Field
Type
Description

id

string

The business identifier of the program template.

Example: TPL-1234-5678

href

string

The resource URI of the terms variant.

Example: v1/programs/PRG-1234-1234/templates/TPL-1234-5678-0001

type

string

Possible values:

CertificateActivate

CertificatePending

CertificateExpired

EnrollmentProcessing

EnrollmentQuerying

EnrollmentCompleted

name

string

The name of the template.

Example: Your certificate has been activated

content

string

The content of the template.

Example: We are delighted to inform you that your certificate has been activated successfully!

default

boolean

  • Each program has 3 defaults automatically generated when the program is created.

  • Each automatically created template will include a default system message that the client account must update.

  • Defaults cannot be deleted, while non-defaults can be deleted.

Example: True

program

The program to which the variant belongs.

audit

audit

The audit information object.

Example:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } }
}

Last updated

Was this helpful?