Skip to main content
POST
/
v1
/
templates
/
campaigns
/
{campaignTemplateId}
/
tier-setup
Add Promotion Tier From Template
curl --request POST \
  --url https://{cluster}.voucherify.io/v1/templates/campaigns/{campaignTemplateId}/tier-setup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "campaign_id": "<string>",
  "name": "<string>",
  "banner": "<string>",
  "metadata": {},
  "hierarchy": 123,
  "active": true,
  "start_date": "2022-09-23T00:00:00.000Z",
  "expiration_date": "2022-09-26T00:00:00.000Z",
  "validity_timeframe": {
    "duration": "PT1H",
    "interval": "P2D"
  },
  "validity_day_of_week": [
    0
  ],
  "validity_hours": {
    "daily": [
      {
        "start_time": "12:00",
        "days_of_week": [
          0
        ],
        "expiration_time": "14:00"
      }
    ]
  },
  "category": "cat_0c9da30e7116ba6bba",
  "category_id": "cat_0c9da30e7116ba6bba"
}'
{
  "created_resources": [
    {
      "id": "val_Z2QPKZhfIlW1",
      "object": "validation_rules"
    }
  ],
  "promotion_tier": {
    "id": "promo_FHRjE8g5Cu2C1C5voqjijl5I",
    "created_at": "2024-10-07T14:40:20.125Z",
    "name": "metadata-test-template-02",
    "banner": null,
    "action": {
      "discount": {
        "type": "AMOUNT",
        "amount_off": 300,
        "aggregated_amount_limit": 900,
        "units": null,
        "effect": "APPLY_TO_ITEMS"
      }
    },
    "metadata": {},
    "hierarchy": 9,
    "campaign": {
      "id": "camp_1oOwcEGaNELf8G5sVN77z0ou",
      "start_date": null,
      "expiration_date": null,
      "active": true,
      "object": "campaign",
      "name": "Promotion request test",
      "created_at": "2024-07-26T11:00:51.278Z",
      "campaign_type": "PROMOTION",
      "category_id": "cat_0d75bdfe4c9030a732",
      "categories": []
    },
    "campaign_id": "camp_1oOwcEGaNELf8G5sVN77z0ou",
    "summary": {
      "redemptions": {
        "total_redeemed": 0
      },
      "orders": {
        "total_amount": 0,
        "total_discount_amount": 0
      }
    },
    "active": true,
    "validity_day_of_week": null,
    "category_id": null,
    "categories": [],
    "object": "promotion_tier",
    "validation_rules_assignments": [
      {
        "id": "asgm_n1ILxyVhKjyACbVL",
        "rule_id": "val_Z2QPKZhfIlW1",
        "related_object_id": "promo_FHRjE8g5Cu2C1C5voqjijl5I",
        "related_object_type": "promotion_tier",
        "created_at": "2024-10-07T14:40:20.125Z",
        "object": "validation_rules_assignment"
      }
    ]
  },
  "object": "promotion_tier_setup"
}

Authorizations

X-App-Id
string
header
required
X-App-Token
string
header
required
Authorization
string
header
required

Path Parameters

campaignTemplateId
string
required
Example:

Body

application/json
campaign_id
string
required
name
string
required
banner
string
metadata
object
hierarchy
integer
active
boolean
start_date
string<date-time>
Example:
expiration_date
string<date-time>
Example:
validity_timeframe
object
validity_day_of_week
enum<integer>[]
validity_hours
object
category
string
Example:
category_id
string
Example:

Response

created_resources
object[]
required
object
enum<string>
required
Available options:
promotion_tier_setup
promotion_tier
object