Pool Definition Object


A pool definition acts as a template for future pools.

Properties
createdDatestringRead-onlyformat date-time

Date and time the pool definition was created.


detailsDetails

Pool definition benefits and settings.


displayNamestringmaxLength 128

Pool definition name.


extendedFieldsExtendedFields

Custom field data for the pool definition object.

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


idstringRead-onlyformat GUIDimmutable

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


programDefinitionIdsArray <string>format GUIDmaxItems 20

List of program definition IDs that are associated with this pool definition.


programDefinitionsArray <ProgramDefinitionInfo>Read-onlymaxItems 20

Program definitions that this pool definition is associated with.


revisionstringRead-onlyformat int64

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

Ignored when creating a pool definition.


updatedDatestringRead-onlyformat date-time

Date and time the pool definition was updated.

Did this help?