Update Campaign Template

Updates the name or description of the campaign template.

📘 Campaign Templates – Documentation

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

PUT /v1/templates/campaigns/{campaignTemplateId}

Update Campaign Template

cURL

curl --request PUT \
  --url https://{cluster}.voucherify.io/v1/templates/campaigns/{campaignTemplateId} \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'

200

{
  "id": "camp_tpl_zLtn2H9fgcG3NwO7t4PAfHcq",
  "name": "Happy Hours Winter Template",
  "description": "Template for a Happy Hours campaign with discount coupons for the winter season.",
  "campaign_type": "DISCOUNT_COUPONS",
  "created_at": "2019-09-09T09:09:09.009Z",
  "updated_at": "2019-09-09T19:09:09.009Z",
  "object": "campaign_template"
}

Authorizations

X-App-Id & X-App-TokenX-Voucherify-OAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

campaignTemplateId · string · required

Pass the campaign template ID that was assigned by Voucherify.

Example:

"camp_tpl_zLtn2H9fgcG3NwO7t4PAfHcq"

Body

application/json

Provide the new name or description for the campaign template

Request body schema for PUT /templates/campaign/{campaignTemplateId}.

name · string

User-defined name of the campaign template. It must be unique.

description · string | null

User-defined description of the campaign template.

Response

200

application/json

Returns the details of an updated campaign template.

Request body schema for PUT /templates/campaign/{campaignTemplateId}.

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"