FAfabric
Redemptions

Delete redemption by ID

Deletes a specific redemption using the corresponding redemptionId value.

delete/redemptions/{redemptionId}

Request

Path parameters

redemptionIdstring required
Example:614b58924e92f6861ac9d43b

The redemption ID generated using the create redemption endpoint to delete the redemption.

Headers

x-fabric-tenant-idstring required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-channel-idstring
Example:12

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

x-client-idstring

A unique identifier obtained from Copilot for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows.

x-fabric-request-idstring
Example:263e731c-45c8-11ed-b878-0242ac120002

A unique request ID.

Response

OK

idstring required

Redemption ID

isDeletedboolean required
  • true: Redemption is deleted.
  • false: Redemption isn't deleted.

Example response

{
  "id": "614b58924e92f6861ac9d43b",
  "isDeleted": true
}

Changes

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