Skip to main content
PUT
/
v1
/
vouchers
/
{code}
curl --request PUT \
  --url https://{cluster}.voucherify.io/v1/vouchers/{code} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "category": "Second",
  "type": "DISCOUNT_VOUCHER",
  "discount": {
    "type": "PERCENT",
    "percent_off": 45,
    "percent_off_formula": "IF(ORDER_AMOUNT > 100;CUSTOMER_METADATA(\"age\");CUSTOMER_METADATA(\"age\") / 2)",
    "amount_limit": 1800,
    "effect": "APPLY_TO_ORDER"
  },
  "start_date": "2020-02-01T00:00:00Z",
  "expiration_date": "2023-12-31T23:59:59Z",
  "validity_timeframe": {
    "duration": "PT2H",
    "interval": "P3D"
  },
  "validity_day_of_week": [
    0,
    1,
    2
  ],
  "active": false,
  "additional_info": "This voucher can be used with other coupons. Please feel free to do so.",
  "metadata": {
    "Season": "Winter"
  }
}'
{
  "id": "v_9PbXndxO3S8xfztwMtIvuMXReonF248m",
  "code": "percent1",
  "campaign": null,
  "campaign_id": null,
  "category": "Second",
  "category_id": "cat_0bb81a481615a37b5e",
  "categories": [
    {
      "id": "cat_0bb81a481615a37b5e",
      "name": "Second",
      "hierarchy": 2,
      "created_at": "2022-09-20T05:58:01.561Z",
      "object": "category"
    }
  ],
  "type": "DISCOUNT_VOUCHER",
  "discount": {
    "type": "PERCENT",
    "amount_limit": 1800,
    "percent_off": 45,
    "percent_off_formula": "IF(ORDER_AMOUNT > 100;CUSTOMER_METADATA(\"age\");CUSTOMER_METADATA(\"age\") / 2)",
    "effect": "APPLY_TO_ORDER"
  },
  "gift": null,
  "loyalty_card": null,
  "start_date": "2020-02-01T00:00:00.000Z",
  "expiration_date": "2023-12-31T23:59:59.000Z",
  "validity_timeframe": {
    "interval": "P3D",
    "duration": "PT2H"
  },
  "validity_day_of_week": [
    0,
    1,
    2
  ],
  "active": false,
  "additional_info": "This voucher can be used with other coupons. Please feel free to do so.",
  "metadata": {
    "Season": "Winter"
  },
  "assets": {
    "qr": {
      "id": "U2FsdGVkX19MPtNCPjoG/pKloolK+BZH/OCIpjYqj+B6IVJJmTYKeBINcB0JioL/tSw3iuK4FvgF8VyDyTfL26IpzbT81DDOnKeFIDUJraQDJiKxWcrG/RCFsVky4olBJ+GZFb9pLpN5gC/rn0pqYw==",
      "url": "{{internalVoucherifyURL}}"
    },
    "barcode": {
      "id": "U2FsdGVkX1/J73XXWgMf2BsVM21kpnFLQak5dpGzThYNTYPT62U6q+5RDlh/CXylkTrhegRnWJw1HA7iehT8iUoV4M4cV0KBdp5WgJ3lXeFZcpX3Mpu0T02PRcYbdCIiSO1kO50Y8Hg/heHcshw22Q==",
      "url": "{{internalVoucherifyURL}}"
    }
  },
  "is_referral_code": false,
  "created_at": "2022-09-19T14:41:30.976Z",
  "updated_at": "2022-09-20T06:00:50.202Z",
  "validation_rules_assignments": {
    "object": "list",
    "data_ref": "data",
    "data": [],
    "total": 0
  },
  "redemption": {
    "quantity": 101,
    "redeemed_quantity": 0,
    "object": "list",
    "url": "/v1/vouchers/percent1/redemptions?page=1&limit=10"
  },
  "publish": {
    "object": "list",
    "count": 0,
    "url": "/v1/vouchers/percent1/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 unique code that identifies the voucher.

Example:

"2CpRCE2c"

Body

application/json

Specify the parameters to be updated.

  • Update loyalty card
  • Update gift card
  • Update voucher in a discount campaign

Request body schema for PUT v1/vouchers/{code}.

​
category
string

The name of the category that this voucher belongs to. Useful when listing vouchers with the List Vouchers endpoint.

​
category_id
string

Unique identifier assigned by Voucherify to the name of the category that this voucher belongs to. Useful when listing vouchers with the List Vouchers endpoint.

Example:

"cat_0bb81a481615a37b5e"

​
start_date
string<date-time>

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

Example:

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

​
expiration_date
string<date-time>

Expiration date defines when the code expires. Expiration timestamp is presented in the 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

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.

Response

Returns the voucher object if the update succeeded.

Response body schema for PUT v1/vouchers/{code}. 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