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

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
code
string
required

A code that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.

Example:

"2CpRCE2c"

Response

Returns a voucher object.

Response body schema for POST v1/vouchers/{code}/disable. This is an object representing a voucher with categories and validation rules assignments. This is an object representing a voucher.

​
id
string

Assigned by the Voucherify API, identifies the voucher.

Example:

"v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV"

​
code
string

A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.

Example:

"WVPblOYX"

​
campaign
string

A unique campaign name, identifies the voucher's parent campaign.

Example:

"Gift Card Campaign"

​
campaign_id
string

Assigned by the Voucherify API, identifies the voucher's parent campaign.

Example:

"camp_FNYR4jhqZBM9xTptxDGgeNBV"

​
category
string

Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.

​
category_id
string

Unique category ID assigned by Voucherify.

Example:

"cat_0bb343dee3cdb5ec0c"

​
type
enum<string>

Defines the type of the voucher.

Available options:
GIFT_VOUCHER,
DISCOUNT_VOUCHER,
LOYALTY_CARD
​
discount
object

Contains information about discount.

  • Amount
  • Unit
  • Unit Multiple
  • Percent
  • Fixed
​
gift
object

Object representing gift parameters. Child attributes are present only if type is GIFT_VOUCHER. Defaults to null.

​
loyalty_card
object

Object representing loyalty card parameters. Child attributes are present only if type is LOYALTY_CARD. Defaults to null.

​
start_date
string<date-time>

Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.

Example:

"2021-12-01T00:00:00.000Z"

​
expiration_date
string<date-time>

Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.

Example:

"2021-12-31T00:00:00.000Z"

​
validity_timeframe
object

Set recurrent time periods when the earning rule is valid. For example, valid for 1 hour every other day.start_date required when including the validity_timeframe.

​
validity_day_of_week
enum<integer>[]

Integer array corresponding to the particular days of the week in which the voucher is valid.

  • 0 Sunday
  • 1 Monday
  • 2 Tuesday
  • 3 Wednesday
  • 4 Thursday
  • 5 Friday
  • 6 Saturday
​
validity_hours
object

Determines the hours of validity, e.g. to create a happy hours scenario.

​
active
boolean | null

A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the start_date and expiration_date.

  • true indicates an active voucher
  • false indicates an inactive voucher
​
additional_info
string

An optional field to keep any extra textual information about the code such as a code description and details.

​
metadata
object

The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.

​
assets
object

Stores links to images of QR and barcode that correspond to an encrypted voucher code.

​
is_referral_code
boolean | null

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

​
created_at
string<date-time>

Timestamp representing the date and time when the voucher was created. The value is shown in the ISO 8601 format.

Example:

"2021-12-22T10:13:06.487Z"

​
updated_at
string<date-time>

Timestamp representing the date and time when the voucher was last updated in ISO 8601 format.

Example:

"2021-12-22T10:14:45.316Z"

​
holder_id
string

Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.

Example:

"cust_eWgXlBBiY6THFRJwX45Iakv4"

​
referrer_id
string

Unique identifier of the referring person.

Example:

"cust_Vzck5i8U3OhcEUFY6MKhN9Rv"

​
object
string
default:voucher

The type of the object represented by JSON. Default is voucher.

​
publish
object

Stores a summary of publication events: an event counter and endpoint to return details of each event. Publication is an assignment of a code to a customer, e.g. through a distribution.

​
redemption
object

Stores a summary of redemptions that have been applied to the voucher.

​
categories
Category · object[]

Contains details about the category.

​
validation_rules_assignments
object

List of Validation Rules Assignments