Delete loyalty reward
DELETE
/v2/loyalty/rewards/{reward_id}
Deletes a loyalty reward by doing the following:
- Returns the loyalty points back to the loyalty account.
- If an order ID was specified when the reward was created (see CreateLoyaltyReward), it updates the order by removing the reward and related discounts.
You cannot delete a reward that has reached the terminal state (REDEEMED).
| Name | Description |
|---|---|
reward_
Required
|
The ID of the loyalty reward to delete. |
Response Fields
| Name | Description |
|---|---|
errors
|
Any errors that occurred during the request. |
Examples
DELETE
/v2/loyalty/rewards/{reward_id}
cURL
- cURL
- Ruby
- Python
- C#
- Java
- PHP
- Node.js
curl https://connect.squareup.com/v2/loyalty/rewards/9f18ac21-233a-31c3-be77-b45840f5a810 \
-X DELETE \
-H 'Square-Version: 2021-05-13' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Response JSON
{}