Program Definition Object


A program definition acts as a template for future programs.

Properties
createdDatestringRead-onlyformat date-time

Date and time the program definition was created.


displayNamestringmaxLength 64

Program definition name.


extendedFieldsExtendedFields

Custom field data for the program definition object.

Extended fields must be configured in the app dashboard before they can be accessed with API calls.


externalIdstringRead-onlyformat GUIDimmutable

ID for the program definition defined by you. You can use externalId to filter queries.


idstringRead-onlyformat GUIDimmutable

Program definition ID.


namespacestringRead-onlyimmutableminLength 1maxLength 20

Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the program definition is updated. To prevent conflicting changes, the current revision must be passed when updating the program definition.

Ignored when creating a program definition.


updatedDatestringRead-onlyformat date-time

Date and time the program definition was updated.

Did this help?