POST

Remove Items From Benefit


Removes up to 100 items from a benefit in a pool definition.

Identify the benefit with poolDefinitionId and benefitKey, and each item with its externalId and category. The method deletes the matching items, and the corresponding pool definition items are then removed asynchronously. Removed items may briefly still appear in Query Pool Definition Items results after the call returns.

Remove Items from Benefit uses a partial success model. An item reference that doesn't match any item assigned to the benefit returns a per-item failure with itemMetadata.error.code set to NOT_FOUND, while the other items are removed. Check bulkActionMetadata for aggregate counts and results for per-item outcomes.

To add items to a benefit, call Add Items to 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/remove-items-from-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?