For the complete documentation index, see llms.txt. This page is also available as Markdown.

Program Template

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 following attributes:

Field
Type
Description

id

string

The business identifier of the program template.

href

string

The resource URI of the terms variant.

type

string

Indicates the type. Allowed values are:

  • certificateActivate

  • certificatePending

  • certificateExpired

  • enrollmentProcessing

  • enrollmentQuerying

  • enrollmentCompleted

name

string

The name of the template.

content

string

The content of the template.

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.

program

Represents the program to which the term item belongs.

audit

(Read-only) Represents the audit object.

Last updated

Was this helpful?