Create or amend a Payment Campaign

Creates the campaign for the calling client, or amends it. A client holds a single campaign and it is identified by the calling credentials, so no campaign identifier appears in the request. Omit version to create; supply the current version to amend. Maps to POST /v1/paymentCampaign on the internal Apps API.

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

Create/amend request envelope. Carries PaymentCampaign only - PaymentCampaignStatus is never accepted on a request.

PaymentCampaign
object
required

The campaign's configuration. Sent on create/amend and returned on every response. A client holds a single campaign, identified by the calling credentials, so the object carries no campaign identifier.

Responses

400

Validation failed (ERR0.03), the client already holds a campaign (AZP6.1), or campaignBudget is below the amount already awarded (AZP6.2).

401

Invalid Authorization header.

403

Caller not authorised.

409

AZP6.3 - version is missing, incorrect or stale on an amend.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json