Update a campaign

patch

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Campaign ID

Body Params

type

string

enum

required

This field is required only when you create a campaign. Main Campaign is a wrapper for multipe Sub Campaings, grouped together. Main Campaign can have own budget and redemptions limit.

Allowed:

status

string

enum

Allowed:

name

string | null

required

The name of the campaign must be unique.

template

string

enum

Valid template values for MainCampaign are: discount, loyalty, gift_card.

Allowed:

description

string | null

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.

team

string | null

budget_code

string | null

created_by

object

updated_by

object

Response

Language

Credentials

Bearer

URL

Loading…

Response

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

application/json

200The updated campaign