This is fake endpoint to describe variant of POST /api/v2.1/campaigns

post

https://admin.sandbox.vouchery.app/api/v2.1/campaigns#___main_campaign

Create a campaign.

Body Params

Object to create

budget_code

string

Nullable. String or null.

currency

string

required

Alpha-3 code

description

string

Nullable. String or null.

max_redemptions

int32

Nullable. The maximum number of redemptions available across all discount campaigns grouped by this campaign.

max_redemptions_unit

int32

Nullable. Integer or null

max_total_budget

double

Nullable. The budget available for all discount campaigns grouped by this campaign.

max_total_budget_unit

int32

Nullable. Integer or null

name

string

required

The name of the campaign must be unique.

status

string

enum

Nullable. String or null.

Allowed:

team

string

Nullable. String or null.

template

string

enum

Nullable. Valid template values for MainCampaign are: discount, loyalty, gift_card. For SubCampaign valid templates are sub_redemption, sub_reward_points, sub_generate_vouchers.

Allowed:

type

string

enum

required

Main Campaign is a wrapper for multiple Sub Campaigns, grouped together. Main Campaign can have own budget and redemptions limit.

Allowed:

Responses

200Created object

401Unauthorized error.

403Forbidden error.

422Unprocessable entity error. Validation failed.

500Internal server error. Try again in a few minutes or contact support.