Delete Voucher

Deletes a voucher. This operation cannot be undone. Additionally, this operation removes any redemptions on the voucher.

If the force parameter is set to false or not set at all, the voucher will be moved to the bin.

DELETE /v1/vouchers/{code}

Delete Voucher

cURL

curl --request DELETE \
  --url https://{cluster}.voucherify.io/v1/vouchers/{code} \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

404

{
  "code": 404,
  "key": "not_found",
  "message": "Resource not found",
  "details": "Cannot find voucher with id 10OFF",
  "request_id": "v-0ae28d3cec96bb1b7e",
  "resource_id": "10OFF",
  "resource_type": "voucher"
}

Authorizations

X-App-Id & X-App-TokenX-Voucherify-OAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

code · string · required

A unique code that identifies the voucher.

Example:

"2CpRCE2c"

Query Parameters

force · boolean

If this flag is set to true, the voucher will be removed permanently. If it is set to false or not set at all, the voucher will be moved to the bin. Going forward, the user will be able to create another voucher with exactly the same code.

Response

204

Returns no content if deletion is successful.