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.

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

campaignId · string · required

The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

Query Parameters

vouchers_count · integer

Number of vouchers that should be added.

Body

application/json

Specify the voucher parameters that you would like to overwrite.

Request body schema for POST v1/campaigns/{campaignId}/vouchers.

code · string

Unique voucher code.

code_config · object

Contains information about the config used for the voucher code. Defines the code's pattern (prefix, postfix, length, charset, etc).

Show child attributes

category · string

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

metadata · object

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.

redemption · object

Stores the quantity of redemptions that can be applied to the voucher.

Show child attributes

additional_info · string

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

start_date · string<date-time>

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

Example:

"2022-09-20T00:00:00.000Z"

expiration_date · string<date-time>

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

Example:

"2022-09-30T00:00:00.000Z"

Response

200

application/json

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

Response body schema for POST v1/campaigns/{campaignId}/vouchers/{code} and POST v1/campaigns/{campaignId}/vouchers. 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

Show child attributes

gift · object

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

Show child attributes

loyalty_card · object

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

Show child attributes

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.

Show child attributes

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

Show child attributes

validity_hours · object

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

Show child attributes

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.

Show child attributes

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.

Show child attributes

redemption · object

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

Show child attributes

categories · Category · object[]

Contains details about the category.

Show child attributes

validation_rules_assignments · object

List of Validation Rules Assignments

Show child attributes