Create Campaign From Template

Creates a campaign out of a campaign template.

To create a campaign, you need to provide the name in the request, while other fields are optional. If no other fields are sent, the configuration from the template will be used.

You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the campaign. When the campaign has been created, then you can:

• Update the validation rule,
• Unassign the validation rule,
• Assign an existing validation rule.

👍 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_COUPON type. You can use this template to create:

• Discount campaign
• Promotion tier

📘 Campaign Templates – Documentation

Read the Campaign Templates documentation to learn more about this feature.

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

campaignTemplateId · string · required

Pass the campaign template ID that was assigned by Voucherify.

Example:

"camp_tpl_zLtn2H9fgcG3NwO7t4PAfHcq"

Body

application/json

Only name is required. The rest of the fields will overwrite the template configuration.

Request body schema for POST /v1/templates/campaigns/{campaignTemplateId}/campaign-setup. Base body schema for creating a campaign

name · string · required

Campaign name.

description · string

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

type · enum<string>

Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of generic (standalone) voucherss.

• AUTO_UPDATE: the campaign is dynamic, i.e. vouchers will generate based on set criteria
• STATIC: vouchers need to be manually published

Available options:

AUTO_UPDATE,

STATIC

join_once · boolean

If this value is set to true, customers will be able to join the campaign only once. For loyalty campaigns, it's forced to true, even if join_once: false is passed in the request.

auto_join · boolean

Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.

use_voucher_metadata_schema · boolean

Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema.

vouchers_count · integer

Total number of unique vouchers in campaign (size of campaign).

start_date · string<date-time>

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

Example:

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

expiration_date · string<date-time>

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

Example:

"2022-09-30T00: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

activity_duration_after_publishing · string

Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days.

category_id · string

Unique category ID that this campaign belongs to. Either pass this parameter OR the category.

Example:

"cat_0b688929a2476386a7"

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 campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format.

access_settings · object

Assigns or unassigns an area or store to the campaign.

NOTE: this object can be sent if the Areas and Stores enterprise feature is enabled. Contact Voucherify Sales to learn more.

Show child attributes

voucher · object

Show child attributes

Response

200

application/json

Returns the details about the created campaign 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}/campaign-setup.

created_resources · object[] · required

Contains a list of resources that have been added to the project when the campaign has been created out of the template.

Show child attributes

campaign · object · required

Details of the created campaign. This is an object representing a campaign.

Show child attributes

object · enum<string> · required

The type of the object represented by JSON. This object stores information about the campaign created out of the campaign template.

Available options:

campaign_setup