Skip to main content
POST
/
v1
/
redeem
/
cancel
Cancel Rewards
curl --request POST \
  --url https://vanilla-dev02-loyalty.fabric.zone/api/v1/redeem/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "profileId": "67460e74-02e3-11e8-b443-00163e990bdb",
  "redemptionCode": "04c229d7-03cb-421f-9d77-1c0ff1fc2641",
  "cancelAuditUser": "Joe"
}'
{
  "status": 200,
  "message": "Reward cancelled successfully.",
  "errors": {},
  "data": "<any>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Details to cancel reward

​
redemptionCode
string<uuid>
required

Redemption code. This code must be specified. It is used to identify and link the rewards used in a specific transaction. This code is generated in the response of the Issue Variable Rewards endpoint - POST /api/v1/redeem/reward/issue.

Example:

"04c229d7-03cb-421f-9d77-1c0ff1fc2641"

​
profileId
string<uuid>

Profile ID of the member. In an ecosystem, it acts as a primary ID to keep the various systems (apps, websites, etc.) in sync.

Example:

"67460e74-02e3-11e8-b443-00163e990bdb"

​
cancelAuditUser
string

Representative who cancelled the audit.

Minimum length: 1
Example:

"Joe"

Response

OK

​
status
integer

Status of the call

Example:

200

​
message
string
default:Exception message

Message corresponding to the status of the call.

Minimum length: 1
Example:

"Reward cancelled successfully."

​
errors
object

Error details, if any.

​
data
any

Additional details, if applicable.

⌘I