v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB

Campaigns

Add Vouchers to Campaign

This method gives the possibility to push new vouchers to an existing campaign. New vouchers will inherit properties from the campaign profile. However, it is possible to overwrite some of them in the request body. If you provide an optional code_config parameter with a voucher code configuration, then it will be used to generate new voucher codes. Otherwise, the voucher code configuration from the campaign will be used.

This API request starts a process that affects Voucherify data in bulk.

In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.

The result will return the async ID. You can verify the status of your request via this API request.

post/v1/campaigns/{campaignId}/vouchers

Query parameters

vouchers_countinteger

Number of vouchers that should be added.

Request body

codestring

Unique voucher code.

categorystring

The category assigned to the campaign. Either pass this parameter OR the category_id.

metadataobject

The metadata object stores all custom attributes assigned to the voucher. 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.

additional_infostring

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

start_datestring date-time

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

expiration_datestring date-time

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

Example request

{
  "start_date": "2022-09-20T00:00:00.000Z",
  "expiration_date": "2022-09-30T00:00:00.000Z"
}

Response

Returns a voucher object if the call succeeded for a voucher count of 1.

idstring

Assigned by the Voucherify API, identifies the voucher.

codestring

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

campaignstring

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

campaign_idstring

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

categorystring

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

category_idstring

Unique category ID assigned by Voucherify.

type'GIFT_VOUCHER' | 'DISCOUNT_VOUCHER' | 'LOYALTY_CARD'

Defines the type of the voucher.

start_datestring date-time

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

expiration_datestring date-time

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

validity_day_of_weekinteger[]

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

activeboolean nullable

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_infostring

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

metadataobject

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.

is_referral_codeboolean nullable

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

created_atstring date-time

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

updated_atstring date-time

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

holder_idstring

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

referrer_idstring

Unique identifier of the referring person.

objectstring

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

Example response

{
  "id": "v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV",
  "code": "WVPblOYX",
  "campaign": "Gift Card Campaign",
  "campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
  "category_id": "cat_0bb343dee3cdb5ec0c",
  "gift": {
    "amount": 10000,
    "balance": 500
  },
  "loyalty_card": {
    "points": 7000,
    "balance": 6970,
    "next_expiration_date": "2023-05-30"
  },
  "start_date": "2021-12-01T00:00:00.000Z",
  "expiration_date": "2021-12-31T00:00:00.000Z",
  "validity_timeframe": {
    "duration": "PT1H",
    "interval": "P2D"
  },
  "validity_hours": {
    "daily": [
      {
        "start_time": "12:00",
        "expiration_time": "14:00"
      }
    ]
  },
  "assets": {
    "qr": {
      "id": "U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==",
      "url": "https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D"
    },
    "barcode": {
      "id": "U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==",
      "url": "https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D"
    }
  },
  "created_at": "2021-12-22T10:13:06.487Z",
  "updated_at": "2021-12-22T10:14:45.316Z",
  "holder_id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
  "referrer_id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv",
  "publish": {
    "url": "/v1/vouchers/WVPblOYX/publications?page=1&limit=10"
  },
  "redemption": {
    "redeemed_quantity": 1,
    "redeemed_points": 100000,
    "url": "/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"
  },
  "categories": [
    {
      "created_at": "2022-07-14T10:45:13.156Z",
      "updated_at": "2022-08-16T10:52:08.094Z"
    }
  ],
  "validation_rules_assignments": {
    "data": [
      {
        "id": "asgm_LnY1g7UNFA9KyDrD",
        "rule_id": "val_3gPNA6SnH4ae",
        "related_object_id": "camp_CZOnEGiZfwIKWmSjhIoIT7Ol",
        "related_object_type": "campaign",
        "object": "validation_rules_assignment",
        "validation_status": "PARTIALLY_VALID",
        "validation_omitted_rules": [
          "1"
        ]
      }
    ]
  }
}