Pool Object


A pool contains benefits that can be redeemed by the pool's beneficiary.

Properties
idstringRead-onlyformat GUIDimmutable

Pool ID.


revisionstringRead-onlyformat int64

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

Ignored when creating a pool.


createdDatestringRead-onlyformat date-time

Date and time the pool was created.


updatedDatestringRead-onlyformat date-time

Date and time the pool was updated.


poolDefinitionIdstringRead-onlyformat GUIDimmutable

ID of the associated pool definition.


programDefinitionIdstringRead-onlyformat GUIDimmutable

ID of the associated program definition.


programIdstringRead-onlyformat GUIDimmutable

ID of the program that contains this pool.


statusstringRead-only

Pool status.


beneficiaryBeneficiaryRead-onlyimmutable

Pool beneficiary.


detailsDetails

Pool benefits and settings.


displayNamestringmaxLength 64

Pool name.

You may want to use the same name that's used in the associated pool definition.


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

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


programDefinitionProgramDefinitionRead-only

Associated program definition information.


programProgramRead-only

Information about the program containing the pool.


poolDefinitionRevisionstringRead-onlyformat int64

Version of the pool definition that this pool was created from.


renewalCountintegerRead-onlyformat int32

Number of times this pool has been renewed.

Did this help?