API ReferenceUser GuidesCommunity Discussions
API Reference
Join our SlackGet Support

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

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

Create a campaign.

Body Params

Object to create

string

Nullable. String or null.

string
required

Currency denominating monetary values in this campaign (USD, GBP, EUR, AUD)

string
required

Currency symbol ($, £, €)

string

Nullable. Text that can be displayed to the customer once the redemption is validated or confirmed.

string

Nullable. String or null.

double

Nullable. Float64 or null

boolean
required
int64

Nullable. If the voucher can be obtained by spending customer's loyalty point, this field states about how many loyalty points are charged when buying a voucher.

double

Nullable. Float64 or null

int32

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

int32

Nullable. Integer or null

double

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

int32

Nullable. Integer or null

string

Nullable. String or null.

double

Nullable. Float64 or null

string
required

The name of the campaign must be unique.

int64
required

Required only for sub campaigns.

string

Nullable. String or null.

string
enum

Nullable. String or null.

Allowed:
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:
string
enum
required

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

Allowed:
string
enum

Nullable. What characters should the code include when new voucher is created. Possible choices are digits, letters, and mixed.

Allowed:
int64

Nullable. Voucher lifetime in seconds

int64

Nullable. The maximum number of redemptions per unique voucher code.

double

Nullable. The maximum total discount of all redemptions per unique voucher code.

string

Nullable. A prefix that will be used to generate vouchers. Needs to be unique within project.

int32

Nullable. How long should the random part of the code be? Valid values are between 2 and 10, depending on batch size.

string
enum

Nullable. Determines what type of vouchers can be generated for campaign. Generic vouchers (eg. SALE10) can be redeemed multiple times. Unique vouchers allow for greater control and better tracking of who and how is using your promotions.

Allowed:
Responses

Updated over 2 years ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 2 years ago