CLcleeng

Redeem a gift

Use this endpoint to redeem a gift. A gift can be redeemed after a successful verification.

post/gifts/{code}/redeem

Request

  • Base URL
    https://api.sandbox.cleeng.com/3.1
  • URL
    https://api.sandbox.cleeng.com/3.1/gifts/{code}/redeem
  • Auth
    API key in header X-Publisher-Token

Path parameters

codestring required

A gift code. Min length: 9, max length: 9. Example: 1A2B-3C4D.

Headers

Content-Typestring

Request body

customerIpstring

Customer (redeemer) IP address.

redeemerIdinteger

The identifier of the person redeeming a gift.

Response

200

messagestring

Example response

{
  "message": "OK"
}

Changes

No recorded changes to this operation across all 1 revision of this API.