Pool Definition Object


A pool definition acts as a template for future pools.

Properties
idstringRead-onlyformat GUIDimmutable

Pool definition ID.


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.


createdDatestringRead-onlyformat date-time

Date and time the pool definition was created.


updatedDatestringRead-onlyformat date-time

Date and time the pool definition was updated.


displayNamestringmaxLength 128

Pool definition name.


programDefinitionIdsArray <string>format GUIDmaxItems 100

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


detailsDetails

Pool definition benefits and settings.


namespacestringRead-onlyimmutableminLength 1maxLength 50

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.


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.

Did this help?