> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Resource: Pool Definitions

# Type: Pool Definition Object

# Link: https://dev.wix.com/docs/api-reference/business-solutions/benefit-programs/pool-definitions/pool-definition-object.md

## Description: A pool definition acts as a template for future pools.

## Schema:

```json
 Type: Pool Definition Object | type: PoolDefinition
 Description: A pool definition acts as a template for future pools.
       - name: id  | type: string | description: Pool definition ID.
           - name: value  | type: string | description: 
       - name: revision  | type: string | description: 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.
           - name: value  | type: string | description: 
       - name: createdDate  | type: string | description: Date and time the pool definition was created.
           - name: seconds  | type: string | description: 
           - name: nanos  | type: number | description: 
       - name: updatedDate  | type: string | description: Date and time the pool definition was updated.
       - name: displayName  | type: string | description: Pool definition name.
       - name: programDefinitionIds  | type: Array<string> | description: List of program definition IDs that are associated with this pool definition.
       - name: details  | type: Details | description: Pool definition benefits and settings.
           - name: benefits  | type: Array<Benefit> | description: List of benefits.
               - name: benefitKey  | type: string | description: Unique identifier for this benefit.  This key is consistent across the pool definition and all associated pools that contain this benefit.
               - name: itemSetId  | type: string | description: ID that is used to associated items with this benefit.
               - name: price  | type: string | description: Price of the benefit in credits. The price is the same for all of this benefit's items.
               - name: additionalData  | type: Struct | description: Additional information for this benefit.
               - name: providerAppId  | type: string | description: ID of the app providing the benefit items.
               - name: displayName  | type: string | description: Benefit name.
               - name: description  | type: string | description: Benefit description.
           - name: creditConfiguration  | type: CreditConfiguration | description: Credit settings.  If this object is empty, you can't set a price for the benefit.
               - name: amount  | type: string | description: Initial available amount for associated balances.
               - name: rolloverConfiguration  | type: RolloverConfiguration | description: Rollover settings.
               - name: unitDisplayName  | type: string | description: Credit unit display name.
           - name: additionalData  | type: Struct | description: Additional information relating to this object.
               - name: fields  | type: object | description: 
       - name: namespace  | type: string | description: 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.
       - name: extendedFields  | type: ExtendedFields | description: Custom field data for the pool definition object.  [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls.
           - name: namespaces  | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md).
       - name: programDefinitions  | type: Array<ProgramDefinitionInfo> | description: Program definitions that this pool definition is associated with.
           - name: id  | type: string | description: Program definition ID.
           - name: externalId  | type: string | description: Program definition external ID.

```