<- Loyalty API

Loyalty API

Cancel loyalty promotion

POST

 /v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel

Cancels a loyalty promotion.

Use this endpoint to cancel an ACTIVE promotion earlier than the end date, cancel an ACTIVE promotion when an end date is not specified, or cancel a SCHEDULED promotion. Because updating a promotion is not supported, you can also use this endpoint to cancel a promotion before you create a new one.

This endpoint sets the loyalty promotion to the CANCELED state

Permissions:LOYALTY_WRITE

Guide

Cancel loyalty promotions

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

promotion_id

string

Required

The ID of the loyalty promotion to cancel. You can cancel a promotion that has an ACTIVE or SCHEDULED status.

Link to section

program_id

string

Required

The ID of the base loyalty program.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Show attributes
Link to section

loyalty_promotion

The canceled loyalty promotion.

Show attributes