Admin — update a campaign

ADMIN

Patches a campaign: omitted fields are left untouched. Not a full
replace — empty is meaningful on most of these fields, so a replace
would let an omitted field silently wipe configuration that gates
discounts and token issuance.

Edits reach live Lambda containers at their next cold start, so allow a
few minutes for a change to take effect everywhere.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

A patch. Every field is optional and an omitted one is left untouched — this is deliberately not a full replace, because empty is meaningful on most of these fields (an empty email_template_key falls back to key, an empty token_unit means no wallet, a null date means unbounded) and a replace would let an omitted field silently wipe configuration that gates discounts and token issuance.
campaign_id is absent on purpose: it is immutable, since orders, vouchers and already-issued tokens all reference it.

client_ids
array of strings

Replaces the whole set. Ids being added must not already belong to another campaign; ids dropped here are released for reuse.

client_ids
date-time | null

Send null to restore an archived campaign to the default listing. Omit to leave its archive state alone. Archiving is normally done with DELETE rather than here.

string
string
string
string
string
string
string
enum
Allowed:
string
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
string
supported_locales
array of strings
supported_locales
string
string
date-time | null
date-time | null
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json