Loyalty promotion updated
EVENT
loyalty.promotion.updated
Published when a loyalty promotion is updated. This event is invoked only when a loyalty promotion is canceled.
Permissions
LOYALTY_READ
Name | Description |
---|---|
merchant_
|
The ID of the Square seller associated with the event. |
type
|
The type of event. For this event, the value is |
event_
|
The unique ID for the event, which is used for idempotency support. |
created_
|
Read only The timestamp of when the event was created, in RFC 3339 format. Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
data
|
The data associated with the event. |
Examples
Example payload
{
"merchant_id": "C337NFWQT2A6W",
"type": "loyalty.promotion.updated",
"event_id": "875f2038-6015-492e-9f29-d040b3809e49",
"created_at": "2022-07-14T01:23:45Z",
"data": {
"type": "loyalty.promotion",
"id": "ba2f8ab6-e131-46d9-9882-17714404eb49",
"object": {
"loyalty_promotion": {
"id": "loypromo_ba2f8ab6-e131-46d9-9882-17714404eb49",
"name": "Happy Hour",
"incentive": {
"type": "POINTS_ADDITION",
"points_addition_data": {
"points_addition": 5
}
},
"available_time": {
"start_date": "2022-06-06",
"time_periods": [
"BEGIN:VEVENT\nDTSTART:20220612T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;BYDAY=SU\nEND:VEVENT",
"BEGIN:VEVENT\nDTSTART:20220606T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;BYDAY=MO\nEND:VEVENT",
"BEGIN:VEVENT\nDTSTART:20220607T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT",
"BEGIN:VEVENT\nDTSTART:20220608T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;BYDAY=WE\nEND:VEVENT",
"BEGIN:VEVENT\nDTSTART:20220609T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;BYDAY=TH\nEND:VEVENT",
"BEGIN:VEVENT\nDTSTART:20220610T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;BYDAY=FR\nEND:VEVENT",
"BEGIN:VEVENT\nDTSTART:20220611T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;BYDAY=SA\nEND:VEVENT"
]
},
"minimum_spend_amount_money": {
"currency": "USD",
"amount": 2000
},
"qualifying_item_variation_ids": [
"CJ3RYL56ITAKMD4VRCM7XERS",
"AT3RYLR3TUA9C34VRCB7X5RR"
],
"status": "CANCELED",
"created_at": "2022-06-03T01:41:34Z",
"canceled_at": "2022-07-14T01:23:45Z",
"updated_at": "2022-07-14T01:23:45Z",
"loyalty_program_id": "5216e8b2-d43e-41e2-9ed8-eccf3e892aef"
}
}
}
}