Program Object


A program has a specific beneficiary who can redeem benefits in the program's pools.

Properties
beneficiaryBeneficiaryRead-onlyimmutable

Program beneficiary.


createdDatestringRead-onlyformat date-time

Date and time the program was created.


displayNamestringmaxLength 64

Program name.

You may want to use the same name that's used in the associated program definition, if it exists.


extendedFieldsExtendedFields

Custom field data for the program 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 defined by you. You can use externalId to filter queries.


idstringRead-onlyformat GUIDimmutable

Program ID.


namespacestringRead-onlyminLength 1maxLength 20immutable

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.


programDefinitionProgramDefinitionRead-only

Associated program definition information.


programDefinitionIdstringRead-onlyformat GUIDimmutable

ID of the associated program definition.


revisionstringRead-onlyformat int64

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

Ignored when creating a program.


statusstringRead-only

Program status.


updatedDatestringRead-onlyformat date-time

Date and time the program was updated.

Did this help?