FAfabric
Redemption

Delete specific redemption record

Delete a specific redemption record by redemptionId

delete/api-offers/redemption/{redemptionId}

Request

Path parameters

redemptionIdstring required
Example:614b58924e92f6861ac9d43b

ID of the redemption record to be deleted

Headers

x-site-contextstring required
Example:{"date": "2023-01-01T00:00:00.000Z", "channel": 12, "account": "1234abcd5678efgh9ijklmno","stage":"production"}

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Response

OK

redemptionIdstring

fabric internal ID

deletedboolean

true: redemption record is deleted<br /> false: redemption record is not deleted

Example response

{
  "redemptionId": "614b58924e92f6861ac9d43b",
  "deleted": true
}

Changes

No recorded changes to this operation across all 2 revisions of this API.