API Documentation

Revoke a Loyalty Promotion

post
https://{host}/v3/promotions/revoke

Revokes a customer's enrollment or opt-in from a v3 unified loyalty promotion.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to false

When true, revokes all active enrollments for the customer on the specified promotion. Only valid with action=REVOKE_ENROLL. Cannot be used together with revokeAllOptIns=true.

boolean
Defaults to false

When true, revokes all active opt-ins for the customer on the specified promotion. Only valid with action=REVOKE_OPTIN. Cannot be used together with revokeAllEnrollments=true.

Body Params
string
length ≤ 50

A plain string reference identifier for this revoke request. Each requestId must be unique per org — duplicate values are rejected.

string
enum
required

The revoke action to perform. Case-sensitive.

Allowed:
int64
required

Unique identifier of the loyalty program.

promotion
object
required

Identifies the promotion to revoke from. Provide exactly one of promotionId or promotionIdentifier.

customers
array of objects
required
length ≤ 1

List of customers to revoke. Exactly 1 entry is supported in the current release.

customers*
string

ISO-8601 timestamp to retroactively stamp as the revoke date. Must not be in the future.

int64

Till ID to stamp on the event log for the revoke and any cascade. Falls back to the authenticated user's till when omitted.

sourceDetails
object

Audit attribution for the revoke operation.

Headers
string
required
string
required
integer

Numeric till ID to attribute the revoke to a specific till. Must be used alongside X-CAP-API-ATTRIBUTION-TILL-CODE when authenticating via OAuth.

Responses

Updated about 1 hour ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 hour ago