Loyalty
CancelLoyaltyPromotion
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
post/v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel
Path parameters
promotion_idstring required
The ID of the loyalty promotion to cancel. You can cancel a promotion that has an ACTIVE or SCHEDULED status.
program_idstring required
The ID of the base loyalty program.
Response
Success
Example response
{
"loyalty_promotion": {
"available_time": {
"start_date": "2022-08-16",
"time_periods": [
"BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT"
]
},
"canceled_at": "2022-08-17T12:42:49Z",
"created_at": "2022-08-16T08:38:54Z",
"id": "loypromo_f0f9b849-725e-378d-b810-511237e07b67",
"incentive": {
"points_multiplier_data": {
"multiplier": "3.000",
"points_multiplier": 3
},
"type": "POINTS_MULTIPLIER"
},
"loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
"minimum_spend_amount_money": {
"amount": 2000,
"currency": "USD"
},
"name": "Tuesday Happy Hour Promo",
"qualifying_category_ids": [
"XTQPYLR3IIU9C44VRCB3XD12"
],
"status": "CANCELED",
"trigger_limit": {
"interval": "DAY",
"times": 1
},
"updated_at": "2022-08-17T12:42:49Z"
}
}