POST

Add Items To Benefit


Adds up to 100 items to a benefit in a pool definition.

Identify the benefit with poolDefinitionId and benefitKey, and each item with its externalId and category. The method creates the corresponding items, inheriting providerAppId, namespace, and itemSetId from the benefit's configuration in the pool definition. The corresponding pool definition items are then created asynchronously, so new items may take a short time to appear in Query Pool Definition Items results after the call returns.

Add Items to Benefit uses a partial success model. An item that's already assigned to the benefit returns a per-item failure in results.itemMetadata, while the other items are added. Check bulkActionMetadata for aggregate counts and results for per-item outcomes.

To remove items from a benefit, call Remove Items from Benefit.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permission Scopes
Manage benefit programs
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/benefit-programs/v1/pool-definition-items/add-items-to-benefit

Errors
404Not Found

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?