Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Update Promotion Status

Updates the status of a loyalty promotion to manage its lifecycle. Supports submitting a promotion for approval, withdrawing it from review, pausing or resuming an active promotion, and stopping a promotion permanently.

put/v3/requests/PROMOTION/{promotionId}/status

Path parameters

promotionIdstring required
Example:<PROMOTION_ID>

The unique identifier of the promotion to update.

Query parameters

existingStatus'DRAFT' | 'PENDING_APPROVAL' | 'ACTIVE' | 'PAUSED' required
Example:DRAFT

The current status of the promotion. The request fails if the promotion's actual status does not match this value.

Headers

Authorizationstring required
Example:Basic <YOUR_AUTH_TOKEN>

Basic or OAuth authentication credentials.

Content-Typestring required
Example:application/json

Request body

promotionStatus'PENDING_APPROVAL' | 'REVOKE' | 'RESUME' | 'PAUSE' | 'STOP' required

The target status for the promotion. Valid values depend on existingStatus: PENDING_APPROVAL (from DRAFT), REVOKE (from PENDING_APPROVAL), PAUSE (from ACTIVE), STOP (from ACTIVE or PAUSED), RESUME (from PAUSED).

Example request

{
  "promotionStatus": "PENDING_APPROVAL"
}

Response

Promotion status updated successfully.

dataobject
errorsobject nullable
warningsobject nullable