Update a reward coupon code
POST /v1/public/rewards/update-coupon
Sets the coupon code on a reward belonging to the authenticated merchant. Redeemed or expired rewards cannot be updated. Coupon codes are stored in uppercase.
Authorization
X-API-Key required
Request body
| Field | Type | Required | Description |
|---|---|---|---|
userRewardId | string | Yes | Identifier of the issued customer reward. |
couponCode | string | Yes | Coupon code to attach to the reward. Remy converts it to uppercase. |
Request example
curl -X POST "https://api.remyrewards.co.uk/v1/public/rewards/update-coupon" \
-H "Accept: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
--data '{
"userRewardId": "66c735e253f2836fbe941234",
"couponCode": "summer20"
}'
Responses
| Status | Description |
|---|---|
200 | The coupon code was updated. |
400 | The request is missing a required value or contains invalid data. |
401 | The API key is missing or invalid. |
404 | The requested integration resource was not found. |
Success response example
{
"success": true,
"userRewardId": "66c735e253f2836fbe941234",
"couponCode": "SUMMER20"
}