These docs are for v1.0. Click to read the latest docs for v2.1.

Update a campaign

patch

https://preview.vouchery.io/api/v1.0/campaigns/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Campaign ID

Body Params

parent_id

integer

required

campaign_type

string

enum

required

Type of campaign.

Allowed:

status

string

enum

Allowed:

name

string

required

The name of the campaign.

description

string | null

customer_information

string | null

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

voucher_type

string

enum

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:

max_total_budget

number | null

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

max_redemptions

number | null

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

minimum_value

number | null

maximum_value

number | null

discount_type

string

enum

Discount type defines if a customer receive should receive a discount of 10% or $10 on their order.

Allowed:

discount_value

number

reward_title

string | null

Short reward title to be displayed to the customer (max. 40 characters)

reward_description

string | null

Short reward description to be displayed to the customer (max. 100 characters)

team

string | null

channel

string | null

purpose

string | null

budget_code

string | null

medium

string | null

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The updated campaign