Create Publication

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.

Query Parameters

join_once

boolean

Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer.

Body

application/json

Specify the publication parameters.

Create Publication With Specific Voucher
Create Publication With Campaign

Request body schema for POST v1/publications.

voucher

string

required

Code of the voucher being published.

customer

Customer · object

required

Contains information about the customer to whom the publication was directed.

Show child attributes

customer.id

string

The ID of an existing customer.

customer.source_id

string

A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored.

customer.name

string

Customer's first and last name.

customer.description

string

An arbitrary string that you can attach to a customer object.

customer.email

string

Customer's email address.

customer.phone

string

Customer's phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel.

customer.birthday

string<date>

Deprecated. ~~Customer's birthdate; format YYYY-MM-DD~~.

customer.birthdate

string<date>

Customer's birthdate; format YYYY-MM-DD.

customer.address

object

Customer's address.

Show child attributes

customer.address.city

string

City

customer.address.state

string

State

customer.address.line_1

string

First line of address.

customer.address.line_2

string

Second line of address.

customer.address.country

string

Country.

customer.address.postal_code

string

Postal code.

customer.metadata

object

A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments.

source_id

string

The merchant's publication ID if it is different from the Voucherify publication ID. It's an optional tracking identifier of a publication. It is really useful in case of an integration between multiple systems. It can be a publication ID from a CRM system, database or 3rd-party service. If source_id is provided only 1 voucher can be published per request.

metadata

object

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

channel

string

Specify the distribution channel.

Response

Returns a publication object if a valid identifier was provided.

Publications Create Response Body
Publications Create Response Body

Response body schema for POST v1/publication and GET v1/publications/create. Response body schema for POST v1/publication and GET v1/publications/create.

string

required

Unique publication ID, assigned by Voucherify.

Example:

"pub_BbjAXnmm8e0SIm3zG8qvvFCP0KuLywtp"

object

enum<string>

default:publication

required

The type of the object represented by the JSON. This object stores information about the publication.

Available options:

publication

created_at

string<date-time>

required

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

Example:

"2022-09-23T09:57:00.434Z"

customer_id

string

required

Unique customer ID of the customer receiving the publication.

Example:

"cust_eWgXlBBiY6THFRJwX45Iakv4"

metadata

object

required

channel

enum<string>

default:API

required

How the publication was originated. It can be your own custom channel or an example value provided here.

Available options:

API

source_id

string | null

required

result

enum<string>

default:SUCCESS

required

Status of the publication attempt.

Available options:

SUCCESS

customer

Customer With Summary Loyalty Referrals · object

required

Show child attributes

customer.summary

Customer Summary · object

required

Show child attributes

customer.summary.redemptions

Customer Summary Redemptions · object

required

Show child attributes

customer.summary.redemptions.total_redeemed

integer

required

Total number of redemptions made by the customer.

customer.summary.redemptions.total_failed

integer

required

Total number of redemptions that failed.

customer.summary.redemptions.total_succeeded

integer

required

Total number of redemptions that succeeded.

customer.summary.redemptions.total_rolled_back

integer

required

Total number of redemptions that were rolled back for the customer.

customer.summary.redemptions.total_rollback_failed

integer

required

Total number of redemption rollbacks that failed.

customer.summary.redemptions.total_rollback_succeeded

integer

required

Total number of redemption rollbacks that succeeded.

customer.summary.redemptions.gift

object

required

Summary of gift card credits.

Show child attributes

customer.summary.redemptions.gift.redeemed_amount

integer

default:0

required

Total amount of gift card credits redeemed by customer. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

customer.summary.redemptions.gift.amount_to_go

integer

default:0

required

Remaining gift card balance across all gift cards. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

customer.summary.redemptions.loyalty_card

object

required

Summary of loyalty points.

Show child attributes

customer.summary.redemptions.loyalty_card.redeemed_points

integer

required

Total number of loyalty points redeemed by the customer.

customer.summary.redemptions.loyalty_card.points_to_go

integer

required

Sum of remaining available point balance across all loyalty cards.

customer.summary.orders

Customer Summary Orders · object

required

Lists details about orders related to the customer. Lists only data for orders with the PAID or FULFILLED status. Data from orders with a CREATED or CANCELED status are not included. The data is updated also when an order changes status.

Show child attributes

customer.summary.orders.total_amount

integer

required

The total amount spent by the customer. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

customer.summary.orders.total_count

integer

required

Total number of orders made by the customer.

customer.summary.orders.average_amount

integer

required

Average amount spent on orders. total_amount ÷ total_count. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

customer.summary.orders.last_order_amount

integer

required

Amount spent on last order. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

customer.summary.orders.last_order_date

string<date-time>

Timestamp representing the date and time of the customer's last order in ISO 8601 format.

Example:

"2022-08-30T11:51:08.029Z"

customer.loyalty

Customer Loyalty · object

required

Show child attributes

customer.loyalty.points

integer

required

Customer's loyalty points minus expired for all loyalty cards which the customer has.

customer.loyalty.referred_customers

integer

required

Total number of customers referred by the customer.

customer.loyalty.campaigns

object

required

Contains campaigns with details about point balances and how many customers were referred by the customer.

Show child attributes

customer.loyalty.campaigns.{key}

object

Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.

Show child attributes

customer.loyalty.campaigns.{key}.points

integer

Remaining point balance in campaign.

customer.loyalty.campaigns.{key}.loyalty_tier

string

Customer's loyalty tier within the campaign.

Example:

"ltr_UJ5Q54Q0OvEhua87Qfv2Ki5x"

customer.loyalty.campaigns.{key}.referred_customers

integer

Number of customers referred by the customer in campaign.

customer.referrals

Customer Referrals · object

required

Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.

Show child attributes

customer.referrals.total

integer

required

Total number of times this customer received a referral, i.e. was referred by another customer.

customer.referrals.campaigns

Customer Referrals Campaigns Item · object[]

required

Contains an array of campaigns that served as the source of a referral for the customer.

Show child attributes

customer.referrals.campaigns.campaign_id

string

required

Unique campaign ID, assigned by Voucherify.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

customer.referrals.campaigns.referrer_id

string

required

Unique referrer ID, assigned by Voucherify. This is the customer ID of a customer that is referring this customer.

Example:

"cust_sehkNIi8Uq2qQuRqSr7xn4Zi"

Related object id

Example:

"r_0b9d4cc4aa164dd073"

Related object type, i.e. redemption.

customer.referrals.campaigns.date

string<date-time>

required

Timestamp representing the date and time when the customer was referred in ISO 8601 format.

Example:

"2022-08-30T10:19:39.196Z"

customer.object

enum<string>

default:customer

required

The type of the object represented by JSON.

Available options:

customer

customer.id

string

The ID of an existing customer that will be linked to redemption in this request.

customer.source_id

string

customer.system_metadata

object

Object used to store system metadata information.

customer.created_at

string<date-time>

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

Example:

"2022-08-30T06:32:07.380Z"

customer.updated_at

string<date-time>

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

Example:

"2022-08-31T06:32:07.380Z"

customer.assets

object

Contains information about the customer's cockpit.

Show child attributes

customer.assets.cockpit_url

string

Customer's cockpit URL address.

customer.name

string

Customer's first and last name.

customer.description

string

An arbitrary string that you can attach to a customer object.

customer.email

string

Customer's email address.

customer.phone

string

Customer's phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel.

customer.birthday

string<date>

Deprecated. ~~Customer's birthdate; format YYYY-MM-DD~~.

customer.birthdate

string<date>

Customer's birthdate; format YYYY-MM-DD.

customer.address

object

Customer's address.

Show child attributes

customer.address.city

string

City

customer.address.state

string

State

customer.address.line_1

string

First line of address.

customer.address.line_2

string

Second line of address.

customer.address.country

string

Country.

customer.address.postal_code

string

Postal code.

customer.metadata

object

vouchers_id

string[]

required

Contains the unique internal voucher ID that was assigned by Voucherify.

voucher

Voucher · object

required

This is an object representing a voucher with categories and validation rules assignments.

Show child attributes

voucher.id

string

Assigned by the Voucherify API, identifies the voucher.

Example:

"v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV"

voucher.code

string

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

Example:

"WVPblOYX"

voucher.campaign

string

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

Example:

"Gift Card Campaign"

voucher.campaign_id

string

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

Example:

"camp_FNYR4jhqZBM9xTptxDGgeNBV"

voucher.category

string

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

voucher.category_id

string

Unique category ID assigned by Voucherify.

Example:

"cat_0bb343dee3cdb5ec0c"

voucher.type

enum<string>

Defines the type of the voucher.

Available options:

GIFT_VOUCHER,

DISCOUNT_VOUCHER,

LOYALTY_CARD

voucher.discount

Discount · object

Contains information about discount.

Discount
Discount
Discount
Discount
Discount

Show child attributes

voucher.discount.type

enum<string>

default:AMOUNT

required

Defines the type of the voucher.

Available options:

AMOUNT

voucher.discount.amount_off

number

required

Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.

voucher.discount.amount_off_formula

string

Formula used to dynamically calculate the discount.

voucher.discount.aggregated_amount_limit

integer

Maximum discount amount per order.

voucher.discount.effect

enum<string>

Defines how the discount is applied to the customer's order.

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS,

APPLY_TO_ITEMS_PROPORTIONALLY,

APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY,

APPLY_TO_ITEMS_BY_QUANTITY

voucher.discount.is_dynamic

boolean

Flag indicating whether the discount was calculated using a formula.

voucher.gift

object

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

Show child attributes

voucher.gift.amount

integer

Total gift card income over the lifetime of the card. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

Example:

10000

voucher.gift.subtracted_amount

integer

Total amount of subtracted credits over the gift card lifetime. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

voucher.gift.balance

integer

Available funds. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

Example:

500

voucher.gift.effect

enum<string>

Defines how the credits are applied to the customer's order.

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS

voucher.loyalty_card

object

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

Show child attributes

voucher.loyalty_card.points

integer

Total number of points added to the loyalty card over its lifespan.

Example:

7000

voucher.loyalty_card.balance

integer

Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points.

Example:

6970

voucher.loyalty_card.next_expiration_date

string<date>

The next closest date when the next set of points are due to expire.

Example:

"2023-05-30"

voucher.loyalty_card.next_expiration_points

integer

The amount of points that are set to expire next.

voucher.loyalty_card.pending_points

integer

Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.

voucher.loyalty_card.expired_points

integer

Shows the total number of expired points over the lifetime of the loyalty card.

voucher.loyalty_card.subtracted_points

integer

Shows the total number of subtracted points over the lifetime of the loyalty card.

voucher.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"

voucher.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"

voucher.validity_timeframe

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

voucher.validity_timeframe.duration

string

Defines the amount of time an earning rule will be active in ISO 8601 format. For example, an earning rule with a duration of PT1H will be valid for a duration of one hour.

Example:

"PT1H"

voucher.validity_timeframe.interval

string

Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, an earning rule with an interval of P2D will be valid every other day.

Example:

"P2D"

voucher.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

Available options:

0,

1,

2,

3,

4,

5,

6

voucher.validity_hours

Validity Hours · object

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

Show child attributes

voucher.validity_hours.daily

object[]

Defines the recurring period(s) when the resource is active. The periods should not overlap.

Show child attributes

voucher.validity_hours.daily.start_time

string<time>

Defines the starting hour of validity in the HH:mm format. The resource is inactive before this time.

Example:

"12:00"

voucher.validity_hours.daily.days_of_week

enum<integer>[]

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

0 Sunday
1 Monday
2 Tuesday
3 Wednesday
4 Thursday
5 Friday
6 Saturday

Available options:

0,

1,

2,

3,

4,

5,

6

voucher.validity_hours.daily.expiration_time

string<time>

Defines the ending hour of validity in the HH:mm format. The resource is inactive after this time.

Example:

"14:00"

voucher.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

voucher.additional_info

string

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

voucher.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.

voucher.assets

Voucher Assets · object

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

Show child attributes

voucher.assets.qr

object

Stores Quick Response (QR) representation of encrypted code.

Show child attributes

voucher.assets.qr.id

string

Encrypted voucher code ID.

Example:

"U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q=="

voucher.assets.qr.url

string

URL to QR code

Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.

size: integer value from 1 to 100
format: string, either png (default) or svg

Example:

"https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D"

voucher.assets.barcode

object

Stores barcode representation of encrypted code.

Show child attributes

voucher.assets.barcode.id

string

Encrypted voucher code ID.

Example:

"U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ=="

voucher.assets.barcode.url

string

URL to barcode

Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.

size: integer value from 1 to 100
format: string, either png (default) or svg

Example:

"https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D"

voucher.is_referral_code

boolean | null

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

voucher.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"

voucher.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"

voucher.holder_id

string

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

Example:

"cust_eWgXlBBiY6THFRJwX45Iakv4"

voucher.referrer_id

string

Unique identifier of the referring person.

Example:

"cust_Vzck5i8U3OhcEUFY6MKhN9Rv"

voucher.object

string

default:voucher

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

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

voucher.publish.object

string

default:list

The type of the object represented is by default list. To get this list, you need to make a call to the endpoint returned in the url attribute.

voucher.publish.count

integer

Publication events counter.

Example:

0

voucher.publish.url

string

The endpoint where this list of publications can be accessed using a GET method. /v1/vouchers/{voucher_code}/publications

Example:

"/v1/vouchers/WVPblOYX/publications?page=1&limit=10"

voucher.redemption

object

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

Show child attributes

voucher.redemption.quantity

integer

How many times a voucher can be redeemed. A null value means unlimited.

voucher.redemption.redeemed_quantity

integer

How many times a voucher has already been redeemed.

Example:

1

voucher.redemption.redeemed_points

integer

Total loyalty points redeemed.

Example:

100000

voucher.redemption.object

string

default:list

The type of the object represented is by default list. To get this list, you need to make a call to the endpoint returned in the url attribute.

voucher.redemption.url

string

The endpoint where this list of redemptions can be accessed using a GET method. /v1/vouchers/{voucher_code}/redemptions

Example:

"/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"

voucher.categories

Category · object[]

Contains details about the category.

Show child attributes

voucher.categories.id

string

required

Unique category ID assigned by Voucherify.

voucher.categories.name

string

required

Category name.

voucher.categories.hierarchy

integer

required

Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.

Required range: x >= 0

voucher.categories.object

enum<string>

default:category

required

The type of the object represented by the JSON. This object stores information about the category.

Available options:

category

voucher.categories.created_at

string<date-time>

required

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

Example:

"2022-07-14T10:45:13.156Z"

voucher.categories.updated_at

string<date-time>

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

Example:

"2022-08-16T10:52:08.094Z"

voucher.validation_rules_assignments

Validation Rules Assignments List · object

List of Validation Rules Assignments

Show child attributes

voucher.validation_rules_assignments.object

enum<string>

default:list

required

The type of the object represented by JSON. This object stores information about validation rules assignments.

Available options:

list

voucher.validation_rules_assignments.data_ref

enum<string>

default:data

required

Identifies the name of the attribute that contains the array of validation rules assignments.

Available options:

data

voucher.validation_rules_assignments.data

Business Validation Rule Assignment · object[]

required

Contains array of validation rules assignments.

Show child attributes

voucher.validation_rules_assignments.data.id

string

required

The unique identifier for a assignment

voucher.validation_rules_assignments.data.rule_id

string

required

The unique identifier for a rule

The unique identifier for a related object

The type of related object

voucher.validation_rules_assignments.data.object

enum<string>

default:validation_rules_assignment

required

The type of the object represented by JSON.

Available options:

validation_rules_assignment

voucher.validation_rules_assignments.data.created_at

string<date-time>

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

Example:

"2022-03-09T11:19:04.819Z"

voucher.validation_rules_assignments.data.updated_at

string<date-time>

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

Example:

"2022-03-09T11:19:04.819Z"

voucher.validation_rules_assignments.data.validation_status

enum<string>

The validation status of the assignment

Available options:

VALID,

PARTIALLY_VALID,

INVALID

voucher.validation_rules_assignments.data.validation_omitted_rules

string[]

The list of omitted rules

voucher.validation_rules_assignments.total

integer

required

Total number of validation rules assignments.

Required range: x >= 0

tracking_id

string

Customer's source_id.

Introduction

Endpoints

Events

Authorizations

Query Parameters

Body

Response