> 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 # CreatePoolDefinition # Package: benefitPrograms # Namespace: PoolDefinitionService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/benefit-programs/pool-definitions/create-pool-definition.md ## Permission Scopes: Manage benefit programs: SCOPE.BENEFIT_PROGRAMS.MANAGE ## Introduction Creates a pool definition. --- ## REST API ### Schema ``` Method: createPoolDefinition Description: Creates a pool definition. URL: https://www.wixapis.com/_api/benefit-programs/v1/pool-definitions Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: poolDefinition, poolDefinition.details, poolDefinition.details.benefits, poolDefinition.details.benefits.benefitKey, poolDefinition.details.benefits.providerAppId, poolDefinition.namespace Method parameters: param name: cascade | type: Cascade - enum: UNKNOWN_CASCADE - Unknown cascade. NEXT_RENEWAL - Changes are applied to existing programs and pools when they are next renewed. IMMEDIATELY - Changes are applied to associated programs and pools immediately. FUTURE_PROVISIONS - Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. param name: poolDefinition | type: PoolDefinition | required: true - name: displayName | type: string | description: Pool definition name. - name: programDefinitionIds | type: array | description: List of program definition GUIDs that are associated with this pool definition. - name: details | type: Details | description: Pool definition benefits and settings. | required: true - name: benefits | type: array | description: List of benefits. | required: true - 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: 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: object | description: Additional information for this benefit. - name: providerAppId | type: string | description: GUID 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: enabled | type: boolean | description: Whether unused credits roll over to a new cycle when a program renews. - name: balanceCap | type: string | description: Maximum number of credits that can roll over to the next cycle when a program renews. - name: unitDisplayName | type: string | description: Credit unit display name. - name: additionalData | type: object | description: Additional information relating to this object. - 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. | required: true - 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). Return type: CreatePoolDefinitionResponse - name: poolDefinition | type: PoolDefinition | description: Created pool definition. - name: id | type: string | description: Pool definition GUID. - 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: createdDate | type: string | description: Date and time the pool definition was created. - 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 | description: List of program definition GUIDs that are associated with this pool definition. - name: details | type: Details | description: Pool definition benefits and settings. - name: benefits | type: array | 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: GUID 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: object | description: Additional information for this benefit. - name: providerAppId | type: string | description: GUID 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: enabled | type: boolean | description: Whether unused credits roll over to a new cycle when a program renews. - name: balanceCap | type: string | description: Maximum number of credits that can roll over to the next cycle when a program renews. - name: unitDisplayName | type: string | description: Credit unit display name. - name: additionalData | type: object | description: Additional information relating to this object. - 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 | description: Program definitions that this pool definition is associated with. - name: id | type: string | description: Program definition GUID. - name: externalId | type: string | description: Program definition external GUID. ``` ### Examples ### CreatePoolDefinition ```curl ~~~cURL curl --request POST https://www.wixapis.com/benefit-programs/v1/pool-definitions \ -H 'Content-type: application/json' \ -H 'Authorization: ' \ --data '{ "pool_definition": { "program_definition_ids": [ "e8c3366e-0c4f-3024-a034-1e0c79146d4c" ], "namespace": "benefit_programs_app", "display_name": "Yoga class", "details": { "benefits": [ { "benefit_key": "001", "display_name": "Group session", "provider_app_id": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "price": "5" }, { "benefit_key": "002", "display_name": "Private session", "provider_app_id": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "price": "15", } ], "credit_configuration": { "amount": "20", "rollover_configuration": { "enabled": true, "balance_cap": "25" } } } }, "cascade": "IMMEDIATELY" }' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.benefitPrograms.PoolDefinitionService.createPoolDefinition(poolDefinition, options) Description: Creates a pool definition. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: poolDefinition, poolDefinition.details, poolDefinition.details.benefits, poolDefinition.details.benefits.benefitKey, poolDefinition.details.benefits.providerAppId, poolDefinition.namespace Method parameters: param name: options | type: CreatePoolDefinitionOptions none - name: cascade | type: Cascade | description: Determines when the changes to the program definitions containing this pool definition will be applied to associated programs. Required if the `poolDefinition.programDefinitionIds` parameter is defined. - enum: - UNKNOWN_CASCADE: Unknown cascade. - NEXT_RENEWAL: Changes are applied to existing programs and pools when they are next renewed. - IMMEDIATELY: Changes are applied to associated programs and pools immediately. - FUTURE_PROVISIONS: Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. param name: poolDefinition | type: PoolDefinition | required: true - name: displayName | type: string | description: Pool definition name. - name: programDefinitionIds | type: array | description: List of program definition GUIDs that are associated with this pool definition. - name: details | type: Details | description: Pool definition benefits and settings. | required: true - name: benefits | type: array | description: List of benefits. | required: true - 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: 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: object | description: Additional information for this benefit. - name: providerAppId | type: string | description: GUID 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: enabled | type: boolean | description: Whether unused credits roll over to a new cycle when a program renews. - name: balanceCap | type: string | description: Maximum number of credits that can roll over to the next cycle when a program renews. - name: unitDisplayName | type: string | description: Credit unit display name. - name: additionalData | type: object | description: Additional information relating to this object. - 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. | required: true - 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). Return type: PROMISE - name: _id | type: string | description: Pool definition GUID. - 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: _createdDate | type: Date | description: Date and time the pool definition was created. - name: _updatedDate | type: Date | description: Date and time the pool definition was updated. - name: displayName | type: string | description: Pool definition name. - name: programDefinitionIds | type: array | description: List of program definition GUIDs that are associated with this pool definition. - name: details | type: Details | description: Pool definition benefits and settings. - name: benefits | type: array | 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: GUID 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: object | description: Additional information for this benefit. - name: providerAppId | type: string | description: GUID 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: enabled | type: boolean | description: Whether unused credits roll over to a new cycle when a program renews. - name: balanceCap | type: string | description: Maximum number of credits that can roll over to the next cycle when a program renews. - name: unitDisplayName | type: string | description: Credit unit display name. - name: additionalData | type: object | description: Additional information relating to this object. - 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 | description: Program definitions that this pool definition is associated with. - name: _id | type: string | description: Program definition GUID. - name: externalId | type: string | description: Program definition external GUID. ``` ### Examples ### createPoolDefinition ```javascript import { poolDefinitions } from '@wix/benefit-programs'; async function createPoolDefinition(poolDefinition,options) { const response = await poolDefinitions.createPoolDefinition(poolDefinition,options); }; ``` ### createPoolDefinition (with elevated permissions) ```javascript import { poolDefinitions } from '@wix/benefit-programs'; import { auth } from '@wix/essentials'; async function myCreatePoolDefinitionMethod(poolDefinition,options) { const elevatedCreatePoolDefinition = auth.elevate(poolDefinitions.createPoolDefinition); const response = await elevatedCreatePoolDefinition(poolDefinition,options); } ``` ### createPoolDefinition (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { poolDefinitions } from '@wix/benefit-programs'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { poolDefinitions }, // Include the auth strategy and host as relevant }); async function createPoolDefinition(poolDefinition,options) { const response = await myWixClient.poolDefinitions.createPoolDefinition(poolDefinition,options); }; ``` ---