Admin — create a campaign

post

https://api.acc.funtrips.io/{stage}/admin/campaigns

ADMIN

Registers a campaign. campaign_id must be free, and every client_id
must not already belong to another campaign — a shared client id breaks
token issuance for that client rather than shadowing the other campaign.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Registers a campaign. Only campaign_id is required — the rest can be filled in later with PATCH.

campaign_id

string

required

client_ids

array of strings

client_ids

website_url

string

psp_provider

string

psp_account

string

key

string

email_template_key

string

webframe_url

string

discount_type

string

enum

Allowed:

partner

string

voucher_application

string

enum

How a VOUCHER campaign's unlock codes apply across a basket. PER_PRODUCT (the default) unlocks one unit per code; WHOLE_BASKET unlocks every unit from a single code. Ignored for other discount types.

Allowed:

loyalty_awards

object

default_locale

string

supported_locales

array of strings

supported_locales

currency

string

token_unit

string

start_date

date-time | null

end_date

date-time | null

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

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

application/json

application/problem+json

201The created campaign.

400The request body or parameters are invalid.

401Missing or invalid authentication credentials.

409The campaign id, or one of the client ids, is already in use.

500An unexpected server error occurred.