Skip to main content
GET
/
v1
/
templates
/
campaigns
/
{campaignTemplateId}
Get Campaign Template
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/templates/campaigns/{campaignTemplateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "id": "camp_tpl_zLtn2H9fgcG3NwO7t4PAfHcq",
  "name": "Happy Hours Template",
  "description": "Template for a Happy Hours campaign with discount coupons.",
  "campaign_type": "DISCOUNT_COUPONS",
  "created_at": "2019-09-09T09:09:09.009Z",
  "object": "campaign_template"
}

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"

Response

Returns the details about a campaign template.

Response body schema for GET /v1/templates/campaign/{campaignTemplateId}. Stores details about a campaign template.

​
id
string
required

Unique identifier of the campaign template. It is assigned by Voucherify.

Example:

"camp_tpl_eR9NsNJ5gqJRN2TG3fqCvbVl"

​
name
string
required

User-defined name of the campaign template.

​
campaign_type
enum<string>
required

Type of the campaign used to create the campaign template. Templates created from a promotion tier are converted to DISCOUNT_COUPONS.

Available options:
DISCOUNT_COUPONS,
GIFT_VOUCHERS
​
created_at
string<date-time>
required

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

Example:

"2024-07-16T09:05:53.175Z"

​
object
enum<string>
required

The type of the object represented by JSON.

Available options:
campaign_template
​
description
string

User-defined description of the campaign template.

​
updated_at
string<date-time>

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

Example:

"2024-07-17T06:25:21.500Z"

⌘I