Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Pass the campaign template ID that was assigned by Voucherify.
"camp_tpl_zLtn2H9fgcG3NwO7t4PAfHcq"
Body
Only name
and campaign_id
are required. The rest of the fields will overwrite the template configuration.
Request body schema for POST /v1/templates/campaigns/{campaignTemplateId}/tier-setup
.
Unique campaign identifier, assigned by Voucherify. Defines the promotion campaign to which the promotion tier will be added.
Name of the promotion tier.
Text to be displayed to your customers on your website.
The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format.
The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy.
A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it's within the active period defined by the start_date
and expiration_date
.
true
indicates an active promotion tierfalse
indicates an inactive promotion tier
Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is inactive before this date.
"2022-09-23T00:00:00.000Z"
Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is inactive after this date.
"2022-09-26T00:00:00.000Z"
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
.
Integer array corresponding to the particular days of the week in which the voucher is valid.
0
Sunday1
Monday2
Tuesday3
Wednesday4
Thursday5
Friday6
Saturday
Determines the hours of validity, e.g. to create a happy hours scenario.
Assign a new or update the promotion tier's category using name.
"cat_0c9da30e7116ba6bba"
Assign a new or update the promotion tier's category using id
"cat_0c9da30e7116ba6bba"
Response
Returns the details about the added promotion tier and about the resources that have been created out of the template and added to the project.
Response body schema for POST /v1/templates/campaigns/{campaignTemplateId}/tier-setup
.
Contains a list of resources that have been added to the project when the promotion tier has been created out of the template.
The type of the object represented by JSON. This object stores information about the campaign created out of the campaign template.
promotion_tier_setup
Details of the added promotion tier. This is an object representing a promotion tier. Promotion tiers are always assigned to a campaign and cannot be used standalone.