Skip to main content
POST
/
v1
/
vouchers
/
{code}
/
disable
Disable Voucher
curl --request POST \
  --url https://{cluster}.voucherify.io/v1/vouchers/{code}/disable \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "id": "v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u",
  "code": "2CpRCE2c",
  "campaign": null,
  "campaign_id": null,
  "category": null,
  "category_id": null,
  "type": "DISCOUNT_VOUCHER",
  "discount": {
    "type": "AMOUNT",
    "amount_off": 300,
    "effect": "APPLY_TO_ITEMS_PROPORTIONALLY"
  },
  "gift": null,
  "loyalty_card": null,
  "start_date": null,
  "expiration_date": null,
  "validity_timeframe": null,
  "validity_day_of_week": null,
  "active": false,
  "additional_info": null,
  "metadata": {},
  "assets": {
    "qr": {
      "id": "U2FsdGVkX1+ro/6HLsfI9E/rz0QEoYv+rcVIEERdbV3gB4104zYyGfpydtSxS1WfpbuiDUfMizQAl1EMzoYsud5XTKBBwUkGkI5IPl84lPz+WQtg4nKpjUS0wcA7AuIbz2zb870YfJO/r5UBS5gCqQ==",
      "url": "{{internalVoucherifyURL}}"
    },
    "barcode": {
      "id": "U2FsdGVkX19SWjP3ZUbFh26gCGb4xm3K95jhzfk1XXlKcYlHPtDTYR3/4dYbig4xxRmkgpQLa93Woz9Hq3h4JBQ+aTlftkEzL4D4OSAWi1aWlfxVikrJd6TMFLh9mmbmskodjs4MIdOFlluDWyarlw==",
      "url": "{{internalVoucherifyURL}}"
    }
  },
  "is_referral_code": false,
  "created_at": "2022-09-19T10:06:07.932Z",
  "updated_at": "2022-09-19T11:53:23.452Z",
  "validation_rules_assignments": {
    "object": "list",
    "data_ref": "data",
    "data": [
      {
        "id": "asgm_HesdqEzt5e9c0T56",
        "rule_id": "val_gZft0NKZSUWK",
        "related_object_id": "v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u",
        "related_object_type": "voucher",
        "created_at": "2022-09-19T10:06:07.934Z",
        "object": "validation_rules_assignment"
      }
    ],
    "total": 1
  },
  "redemption": {
    "quantity": null,
    "redeemed_quantity": 0,
    "object": "list",
    "url": "/v1/vouchers/2CpRCE2c/redemptions?page=1&limit=10"
  },
  "publish": {
    "object": "list",
    "count": 0,
    "url": "/v1/vouchers/2CpRCE2c/publications?page=1&limit=10"
  },
  "object": "voucher"
}

Authorizations

X-App-Id
string
header
required
X-App-Token
string
header
required
Authorization
string
header
required

Path Parameters

code
string
required
Example:

Response

id
string
Example:
code
string
Example:
campaign
string
Example:
campaign_id
string
Example:
category
string
category_id
string
Example:
type
enum<string>
Available options:
GIFT_VOUCHER,
DISCOUNT_VOUCHER,
LOYALTY_CARD
discount
object
  • Amount
  • Unit
  • Unit Multiple
  • Percent
  • Fixed
gift
object
loyalty_card
object
start_date
string<date-time>
Example:
expiration_date
string<date-time>
Example:
validity_timeframe
object
validity_day_of_week
enum<integer>[]
validity_hours
object
active
boolean | null
additional_info
string
metadata
object
assets
object
is_referral_code
boolean | null
created_at
string<date-time>
Example:
updated_at
string<date-time>
Example:
holder_id
string
Example:
referrer_id
string
Example:
object
string
default:voucher
publish
object
redemption
object
categories
Category · object[]
validation_rules_assignments
object