CLcleeng

Update a gift

This endpoint gives possibility to update delivery details of a given gift that was previously purchased.

patch/gifts/{giftId}

Request

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

Path parameters

giftIdinteger required

Gift identifier at Cleeng. It can be retrieved from the transaction list (targetId).

Headers

Content-Typestring

Request body

Response

200

idinteger
codestring
offerIdstring
sentAtunknown
redeemedAtunknown

Example response

{
  "id": 123456789,
  "code": "AAAA-BBBB",
  "offerId": "S123123123_PL",
  "deliveryDetails": {
    "personalNote": "Happy birthday",
    "recipientEmail": "johndoe@test.com",
    "deliveryDate": 1691193600
  }
}

Changes

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