Skip to main content
POST
Scope required: rewards.issue
This endpoint revokes all rewards that were issued by a given issuance job. Revocation is processed asynchronously. The endpoint returns 202 Accepted and the job transitions to a revoking state while rewards are being revoked in the background. Only issuance jobs in a completed or failed state can be revoked. Jobs that are pending or processing will return a 422 error. Jobs that are already revoking or revoked will also return a 422 error.

Parameters

id
string
required
Issuance job ID
merchant_id
string
required
Merchant ID

Response

Returns 202 Accepted with the issuance job object.
id
string
Issuance job ID
campaign_id
string
Campaign ID
variant_id
string
Variant ID
state
string
Job state: revoking after a successful revocation request
total_count
integer
Total number of identifiers submitted
processed_count
integer
Number of identifiers processed
success_count
integer
Number of rewards successfully issued
failure_count
integer
Number of failed issuances
progress_percent
integer
Completion percentage (0-100)
created_at
datetime
Job creation timestamp (ISO8601)
started_at
datetime
Processing start timestamp (ISO8601)
completed_at
datetime
Processing completion timestamp (ISO8601)