VOvoucherifyio
Templates

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}

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v1/templates/campaigns/{campaignTemplateId}
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or OAuth 2
      Implicit: https://api.voucherify.io/v1/oauth/token
      Scopes: api, templates

Request body

namestring

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

descriptionstring nullable

User-defined description of the campaign template.

Response

Returns the details of an updated 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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.