Objects stores information about the campaign related to the reward.
Any of:
Discount Coupons
Attributes
Description
Example
id
Unique campaign ID, assigned by Voucherify.
camp_13BbZ0kQsNinhqsX3wUts2UP
type
Campaign type.
Gift Vouchers
Attributes
Description
Example
id
Unique campaign ID, assigned by Voucherify.
camp_13BbZ0kQsNinhqsX3wUts2UP
balance
The incremental amout to be added to the current balance on the gift card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.
type
Campaign type.
Points on loyalty card
Attributes
Description
Example
id
Unique campaign ID, assigned by Voucherify.
camp_13BbZ0kQsNinhqsX3wUts2UP
balance
The incremental points to be added to the current balance on the loyalty card.
type
Campaign type.
Pay with Points
Attributes
Description
Example
coin
Defines the ratio by mapping the number of loyalty points in points_ratio to a predefined cash amount in exchange_ratio.
Attributes
Description
Example
exchange_ratio
The cash equivalent of the points defined in the points_ratio property.
points_ratio
The number of loyalty points that will map to the predefined cash amount defined by the exchange_ratio property.
Material
Attributes
Description
Example
product
Contains information about the product given as a reward.
Attributes
Description
Example
id
Unique product ID, assigned by Voucherify.
prod_0b7d7dfb05cbe5c616
sku_id
Unique SKU ID, assigned by Voucherify, of the SKU given as a reward.
sku_0b7d7dfb090be5c619
stock
Configurable for material rewards. The number of units of the product that you want to share as reward.
redeemed
Defines the number of already invoked (successful) reward redemptions.
attributes
These properties are configurable for material rewards.
Attributes
Description
Example
image_url
The HTTPS URL pointing to the .png or .jpg file.
description
An arbitrary string that you can attach to a material reward.
created_at
Timestamp representing the date and time when the reward was created in ISO 8601 format.
2022-08-11T14:49:22.586Z
updated_at
Timestamp representing the date and time when the reward was updated in ISO 8601 format.
2022-08-11T16:01:34.885Z
metadata
The metadata object stores all custom attributes assigned to the reward. A set of key/value pairs that you can attach to a reward object. It can be useful for storing additional information about the reward in a structured format.
object
The type of object represented by the JSON. This object stores information about the reward.
Language
URL
Click Try It! to start a request and see the response here!