curl --request POST \
  --url https://{cluster}.voucherify.io/v1/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "name": "Discount Campaign 4",
  "campaign_type": "DISCOUNT_COUPONS",
  "join_once": true,
  "type": "AUTO_UPDATE",
  "start_date": "2020-08-16T00:00:00Z",
  "expiration_date": "2023-12-26T00:00:00Z",
  "vouchers_count": 3,
  "voucher": {
    "type": "DISCOUNT_VOUCHER",
    "discount": {
      "percent_off": 10,
      "type": "PERCENT"
    },
    "redemption": {
      "quantity": 10
    },
    "code_config": {
      "pattern": "10OFF-#######"
    }
  },
  "validity_timeframe": {
    "interval": "P2D",
    "duration": "P1D"
  },
  "validity_day_of_week": [
    0,
    1,
    2
  ],
  "activity_duration_after_publishing": "P24D",
  "use_voucher_metadata_schema": false,
  "metadata": {
    "region": "AMER"
  }
}'

{
  "id": "camp_NdBCAQk1AAZcMcv6kt6X164Q",
  "name": "Discount Campaign 4",
  "campaign_type": "DISCOUNT_COUPONS",
  "type": "AUTO_UPDATE",
  "voucher": {
    "type": "DISCOUNT_VOUCHER",
    "discount": {
      "type": "PERCENT",
      "percent_off": 10
    },
    "redemption": {
      "quantity": 10
    },
    "code_config": {
      "length": 7,
      "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
      "pattern": "10OFF-#######"
    },
    "is_referral_code": false,
    "start_date": "2020-08-16T00:00:00.000Z",
    "expiration_date": "2023-12-26T00:00:00.000Z",
    "validity_timeframe": {
      "interval": "P2D",
      "duration": "P1D"
    }
  },
  "auto_join": false,
  "join_once": true,
  "use_voucher_metadata_schema": false,
  "start_date": "2020-08-16T00:00:00.000Z",
  "expiration_date": "2023-12-26T00:00:00.000Z",
  "validity_timeframe": {
    "interval": "P2D",
    "duration": "P1D"
  },
  "validity_day_of_week": [
    0,
    1,
    2
  ],
  "activity_duration_after_publishing": "P24D",
  "vouchers_count": 0,
  "active": true,
  "metadata": {
    "region": "AMER"
  },
  "created_at": "2022-09-21T09:25:49.617Z",
  "category": "First",
  "creation_status": "IN_PROGRESS",
  "vouchers_generation_status": "IN_PROGRESS",
  "protected": false,
  "validation_rules_assignments": {
    "object": "list",
    "data_ref": "data",
    "data": [],
    "total": 0
  },
  "category_id": "cat_0bb343dee3cdb5ec0c",
  "categories": [
    {
      "id": "cat_0bb343dee3cdb5ec0c",
      "name": "First",
      "hierarchy": 1,
      "created_at": "2022-09-16T11:47:19.568Z",
      "object": "category"
    }
  ],
  "object": "campaign"
}

Create Campaign

Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes.

📘 Global uniqueness

All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code.

🚧 Code generation status

This is an asynchronous action; you can’t read or modify a newly created campaign until the code generation is completed. See the creation_status field in the campaign object description.

🚧 Standalone Vouchers and Campaigns

In version v20241004, generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the "type": "STANDALONE" through the API. Voucherify developers work on adding that feature.

Follow the Voucherify Release Notes for more details about released features.

POST

campaigns

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "name": "Discount Campaign 4",
  "campaign_type": "DISCOUNT_COUPONS",
  "join_once": true,
  "type": "AUTO_UPDATE",
  "start_date": "2020-08-16T00:00:00Z",
  "expiration_date": "2023-12-26T00:00:00Z",
  "vouchers_count": 3,
  "voucher": {
    "type": "DISCOUNT_VOUCHER",
    "discount": {
      "percent_off": 10,
      "type": "PERCENT"
    },
    "redemption": {
      "quantity": 10
    },
    "code_config": {
      "pattern": "10OFF-#######"
    }
  },
  "validity_timeframe": {
    "interval": "P2D",
    "duration": "P1D"
  },
  "validity_day_of_week": [
    0,
    1,
    2
  ],
  "activity_duration_after_publishing": "P24D",
  "use_voucher_metadata_schema": false,
  "metadata": {
    "region": "AMER"
  }
}'

{
  "id": "camp_NdBCAQk1AAZcMcv6kt6X164Q",
  "name": "Discount Campaign 4",
  "campaign_type": "DISCOUNT_COUPONS",
  "type": "AUTO_UPDATE",
  "voucher": {
    "type": "DISCOUNT_VOUCHER",
    "discount": {
      "type": "PERCENT",
      "percent_off": 10
    },
    "redemption": {
      "quantity": 10
    },
    "code_config": {
      "length": 7,
      "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
      "pattern": "10OFF-#######"
    },
    "is_referral_code": false,
    "start_date": "2020-08-16T00:00:00.000Z",
    "expiration_date": "2023-12-26T00:00:00.000Z",
    "validity_timeframe": {
      "interval": "P2D",
      "duration": "P1D"
    }
  },
  "auto_join": false,
  "join_once": true,
  "use_voucher_metadata_schema": false,
  "start_date": "2020-08-16T00:00:00.000Z",
  "expiration_date": "2023-12-26T00:00:00.000Z",
  "validity_timeframe": {
    "interval": "P2D",
    "duration": "P1D"
  },
  "validity_day_of_week": [
    0,
    1,
    2
  ],
  "activity_duration_after_publishing": "P24D",
  "vouchers_count": 0,
  "active": true,
  "metadata": {
    "region": "AMER"
  },
  "created_at": "2022-09-21T09:25:49.617Z",
  "category": "First",
  "creation_status": "IN_PROGRESS",
  "vouchers_generation_status": "IN_PROGRESS",
  "protected": false,
  "validation_rules_assignments": {
    "object": "list",
    "data_ref": "data",
    "data": [],
    "total": 0
  },
  "category_id": "cat_0bb343dee3cdb5ec0c",
  "categories": [
    {
      "id": "cat_0bb343dee3cdb5ec0c",
      "name": "First",
      "hierarchy": 1,
      "created_at": "2022-09-16T11:47:19.568Z",
      "object": "category"
    }
  ],
  "object": "campaign"
}

Authorizations

X-App-Id

string

header

required

X-App-Token

string

header

required

Authorization

string

header

required

Body

application/json

Schema that contains unique properties for Discount Coupons Campaign
Schema that contains unique properties for Referral Program
Schema that contains unique properties for Gift Campaign
Schema that contains unique properties for Loyalty Campaign
Schema that contains unique properties for Promotion Campaign

campaign_type

enum<string>

default:DISCOUNT_COUPONS

Available options:

DISCOUNT_COUPONS

voucher

object

Show child attributes

name

string

description

string

type

enum<string>

Available options:

AUTO_UPDATE,

STATIC

join_once

boolean

auto_join

boolean

use_voucher_metadata_schema

boolean

vouchers_count

integer

start_date

string<date-time>

Example:

expiration_date

string<date-time>

Example:

validity_timeframe

object

Show child attributes

validity_day_of_week

enum<integer>[]

Show child attributes

validity_hours

object

Show child attributes

activity_duration_after_publishing

string

category_id

string

Example:

Response

string

required

Example:

name

string

required

campaign_type

enum<string>

required

Available options:

LOYALTY_PROGRAM,

GIFT_VOUCHERS,

DISCOUNT_COUPONS,

PROMOTION,

REFERRAL_PROGRAM

type

enum<string>

required

Available options:

AUTO_UPDATE,

STATIC,

STANDALONE

auto_join

boolean

required

join_once

boolean

required

use_voucher_metadata_schema

boolean

required

created_at

string<date-time>

required

Example:

creation_status

enum<string>

required

Available options:

DONE,

IN_PROGRESS,

FAILED,

DRAFT,

MODIFYING

vouchers_generation_status

enum<string>

required

Available options:

DONE,

IN_PROGRESS,

FAILED,

DRAFT,

MODIFYING

protected

boolean

required

category_id

string | null

required

Example:

Introduction

Endpoints

Events

Create Campaign

Authorizations

Body

Response