> 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 # UpdatePool # Package: benefitPrograms # Namespace: PoolService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/benefit-programs/pools/update-pool.md ## Permission Scopes: Manage benefit programs: SCOPE.BENEFIT_PROGRAMS.MANAGE ## Introduction Updates a pool. Each time the pool is updated, `revision` increments by 1. The current `revision` must be passed when updating the pool. This ensures you're working with the latest pool and prevents unintended overwrites. --- ## REST API ### Schema ``` Method: updatePool Description: Updates a pool. Each time the pool is updated, `revision` increments by 1. The current `revision` must be passed when updating the pool. This ensures you're working with the latest pool and prevents unintended overwrites. URL: https://www.wixapis.com/benefit-programs/v1/pools/{pool.id} Method: PATCH # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: pool, pool.id, pool.revision Method parameters: param name: pool | type: Pool | required: true - name: id | type: string | description: Pool GUID. | required: true - name: revision | type: string | description: 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. | required: true - name: details | type: Details | description: Pool 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: 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: displayName | type: string | description: Pool name. You may want to use the same name that's used in the associated pool definition. - name: extendedFields | type: ExtendedFields | description: Custom field data for the pool 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: UpdatePoolResponse - name: pool | type: Pool | description: Updated pool. - name: id | type: string | description: Pool GUID. - name: revision | type: string | description: 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. - name: createdDate | type: string | description: Date and time the pool was created. - name: updatedDate | type: string | description: Date and time the pool was updated. - name: poolDefinitionId | type: string | description: GUID of the associated pool definition. - name: programDefinitionId | type: string | description: GUID of the associated program definition. - name: programId | type: string | description: GUID of the program that contains this pool. - name: status | type: PoolStatus | description: Pool status. - enum: - ACTIVE: Pool is active. - PAUSED: Pool is paused. It can be resumed. - ENDED: Pool is ended. It can't be resumed. - PROVISIONING: Pool provisioning is in progress. This status exists for a short time during processing. - RENEWING: Pool renewing is in progress. This status exists for a short time during processing. - PENDING: Pool is pending - name: beneficiary | type: IdentificationData | description: Pool beneficiary. - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that hasn't logged in to the site. - name: memberId | type: string | description: GUID of a site member. - name: wixUserId | type: string | description: GUID of a Wix user. - name: details | type: Details | description: Pool 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: displayName | type: string | description: Pool name. You may want to use the same name that's used in the associated pool definition. - 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 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: programDefinition | type: ProgramDefinitionInfo | description: Associated program definition information. - name: id | type: string | description: Program definition GUID. - name: externalId | type: string | description: Program definition external GUID. - name: displayName | type: string | description: Display name of the program definition. - name: description | type: string | description: Description of the program definition. - name: program | type: ProgramInfo | description: Information about the program containing the pool. - name: id | type: string | description: Program GUID. - name: externalId | type: string | description: Program external GUID. - name: displayName | type: string | description: Display name of the program. - name: poolDefinitionRevision | type: string | description: Version of the pool definition that this pool was created from. - name: renewalCount | type: integer | description: Number of times this pool has been renewed. ``` ### Examples ### UpdatePool ```curl ~~~cURL curl --request PATCH https://www.wixapis.com/benefit-programs/v1/pools/e189a369-bb35-42c2-9a49-27c9a0a205d9 \ -H "Authorization: " \ -H "Content-Type: application/json" \ -H "User-Agent: FireConsole/1.0" \ --data '{ "pool": { "id": "e189a369-bb35-42c2-9a49-27c9a0a205d9", "display_name": "Yoga courses", "revision": "3", } }' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.benefitPrograms.PoolService.updatePool(_id, pool) Description: Updates a pool. Each time the pool is updated, `revision` increments by 1. The current `revision` must be passed when updating the pool. This ensures you're working with the latest pool and prevents unintended overwrites. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: pool, _id, pool.revision Method parameters: param name: _id | type: string | description: Pool GUID. | required: true param name: pool | type: UpdatePool | required: true - name: revision | type: string | description: 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. | required: true - name: details | type: Details | description: Pool 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: 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: displayName | type: string | description: Pool name. You may want to use the same name that's used in the associated pool definition. - name: extendedFields | type: ExtendedFields | description: Custom field data for the pool 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 GUID. - name: revision | type: string | description: 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. - name: _createdDate | type: Date | description: Date and time the pool was created. - name: _updatedDate | type: Date | description: Date and time the pool was updated. - name: poolDefinitionId | type: string | description: GUID of the associated pool definition. - name: programDefinitionId | type: string | description: GUID of the associated program definition. - name: programId | type: string | description: GUID of the program that contains this pool. - name: status | type: PoolStatus | description: Pool status. - enum: - ACTIVE: Pool is active. - PAUSED: Pool is paused. It can be resumed. - ENDED: Pool is ended. It can't be resumed. - PROVISIONING: Pool provisioning is in progress. This status exists for a short time during processing. - RENEWING: Pool renewing is in progress. This status exists for a short time during processing. - PENDING: Pool is pending - name: beneficiary | type: IdentificationData | description: Pool beneficiary. - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that hasn't logged in to the site. - name: memberId | type: string | description: GUID of a site member. - name: wixUserId | type: string | description: GUID of a Wix user. - name: details | type: Details | description: Pool 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: displayName | type: string | description: Pool name. You may want to use the same name that's used in the associated pool definition. - 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 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: programDefinition | type: ProgramDefinitionInfo | description: Associated program definition information. - name: _id | type: string | description: Program definition GUID. - name: externalId | type: string | description: Program definition external GUID. - name: displayName | type: string | description: Display name of the program definition. - name: description | type: string | description: Description of the program definition. - name: program | type: ProgramInfo | description: Information about the program containing the pool. - name: _id | type: string | description: Program GUID. - name: externalId | type: string | description: Program external GUID. - name: displayName | type: string | description: Display name of the program. - name: poolDefinitionRevision | type: string | description: Version of the pool definition that this pool was created from. - name: renewalCount | type: integer | description: Number of times this pool has been renewed. ``` ### Examples ### updatePool ```javascript import { pools } from '@wix/benefit-programs'; async function updatePool(_id,pool) { const response = await pools.updatePool(_id,pool); }; ``` ### updatePool (with elevated permissions) ```javascript import { pools } from '@wix/benefit-programs'; import { auth } from '@wix/essentials'; async function myUpdatePoolMethod(_id,pool) { const elevatedUpdatePool = auth.elevate(pools.updatePool); const response = await elevatedUpdatePool(_id,pool); } ``` ### updatePool (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 { pools } from '@wix/benefit-programs'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { pools }, // Include the auth strategy and host as relevant }); async function updatePool(_id,pool) { const response = await myWixClient.pools.updatePool(_id,pool); }; ``` ---