curl --request POST \
--url https://{cluster}.voucherify.io/v1/templates/campaigns \
--header 'Content-Type: application/json' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>' \
--data '
{
"name": "<string>",
"campaign_id": "<string>",
"promotion_tier_id": "<string>",
"description": "<string>"
}
'{
"id": "camp_tpl_0f887664cfe19f2162",
"name": "Template Halloween Campaigns",
"description": "Reuse every October",
"campaign_type": "DISCOUNT_COUPONS",
"created_at": "2024-10-17T14:37:59.488Z",
"object": "campaign_template"
}Creates a template for a discount or gift campaign, or a promotion tier.
A template stores campaign configuration without the following details:
- Campaign name
- Category
- Code count
The following elements are not supported by campaign templates:
- Redeeming API keys
- Redeeming users
- Customer loyalty tier
- Static segments
👍 Promotion Tiers and Campaign Templates
You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the
DISCOUNT_COUPONtype. You can use this template to create:
📘 Campaign Templates – Documentation
Read the Campaign Templates documentation to learn more about this feature.
curl --request POST \
--url https://{cluster}.voucherify.io/v1/templates/campaigns \
--header 'Content-Type: application/json' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>' \
--data '
{
"name": "<string>",
"campaign_id": "<string>",
"promotion_tier_id": "<string>",
"description": "<string>"
}
'{
"id": "camp_tpl_0f887664cfe19f2162",
"name": "Template Halloween Campaigns",
"description": "Reuse every October",
"campaign_type": "DISCOUNT_COUPONS",
"created_at": "2024-10-17T14:37:59.488Z",
"object": "campaign_template"
}Authorizations
Body
Provide details for a campaign template
Request body schema for POST /templates/campaign.
User-defined name of the campaign template. It must be unique.
Unique identifier of the campaign that will create a template. It must be an ID of an existing discount or gift card campaign. It cannot be passed when promotion_tier_id has value. Required when the promotion_tier_id is not passed or it is null.
Unique identifier of the promotion tier that will create a template. It cannot be passed when campaign_id has value. Required when the campaign_id is not passed or it is null.
User-defined description of the campaign template.
Response
Returns the details of a created campaign template.
Response body schema for POST /v1/templates/campaigns.
Unique identifier of the campaign template. It is assigned by Voucherify.
"camp_tpl_eR9NsNJ5gqJRN2TG3fqCvbVl"
User-defined name of the campaign template.
Type of the campaign used to create the campaign template. Templates created from a promotion tier are converted to DISCOUNT_COUPONS.
DISCOUNT_COUPONS, GIFT_VOUCHERS Timestamp representing the date and time when the campaign template was created. The value is shown in the ISO 8601 format.
"2024-07-16T09:05:53.175Z"
The type of the object represented by JSON.
campaign_template User-defined description of the campaign template.
Was this page helpful?