v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Templates

Get Campaign Template

Retrieves a campaign template available in the project.

📘 Campaign Templates – Documentation

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

get/v1/templates/campaigns/{campaignTemplateId}

Query parameters

expand'json_template'

Expands the result with additional data. Currently, the result can be only expanded with a JSON template of the campaign.

Response

Returns the details about a campaign template.

idstring required

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

namestring required

User-defined name of the campaign template.

descriptionstring

User-defined description of the campaign template.

campaign_type'DISCOUNT_COUPONS' | 'GIFT_VOUCHERS' required

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

created_atstring date-time required

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

object'campaign_template' required

The type of the object represented by JSON.

updated_atstring 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 response

{
  "id": "camp_tpl_eR9NsNJ5gqJRN2TG3fqCvbVl",
  "created_at": "2024-07-16T09:05:53.175Z",
  "updated_at": "2024-07-17T06:25:21.500Z"
}