Skip to main content
POST
cURL
Customers are identified by their customer_key. Use revoke_from: "specific" with a customer_keys array to revoke from a chosen set of customers, or revoke_from: "all" to revoke from every customer that currently holds this promotional entitlement.
Only customers with an active assignment for this promotional entitlement are affected. Revoking takes effect immediately.

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

The unique identifier of the promotional entitlement to revoke

Body

application/json
revoke_from
enum<string>
default:specific

specific revokes only from the customers listed in customer_keys. all revokes from every customer that currently holds this promotional entitlement.

Available options:
specific,
all
Example:

"specific"

customer_keys
string[]

The customer keys to revoke the promotional entitlement from. Required when revoke_from is specific.

Example:

Response

Promotional entitlement revoked

statusCode
integer
Example:

200

message
string
Example:

"Promotional entitlement revoked"

meta
object
data
any[]
errors
object