Prepare a campaign

Queues preparation with launch disabled. Requires the existing subscription, wallet, creative ownership and licence checks. Returns a job to poll. dailyBudgetCents is the TOTAL across locations.

Authorization

AuthorizationBearer <token>

Create a scoped key in Benjiads → Integrations. Sent only in Authorization.

In: header

8–80 letters, digits, underscores or hyphens. Reuse the same key and arguments for retries. Completed mutations replay for at least 90 days; a pending operation returns 409 and must be reconciled before using a new key.

Match^[A-Za-z0-9_-]+$

Length8 <= length <= 80

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/campaigns" \  -H "Idempotency-Key: stringst" \  -H "Content-Type: application/json" \  -d '{    "dailyBudgetCents": 0  }'

{  "job": {    "id": "string",    "status": "string",    "hold": "string",    "attempts": 0,    "adsWanted": 0,    "adsCreated": 0,    "campaignId": "string",    "liveAt": "string",    "nextRunAt": "string",    "lastError": "string"  }}

Prepare a campaign

Queues preparation with launch disabled. Requires the existing subscription, wallet, creative ownership and licence checks. Returns a job to poll. dailyBudgetCents is the TOTAL across locations.

Authorization

AuthorizationBearer <token>

Create a scoped key in Benjiads → Integrations. Sent only in Authorization.

In: header

Header Parameters

Idempotency-Key*string

Match^[A-Za-z0-9_-]+$

Length8 <= length <= 80

Request Body

application/json

name?string

Length1 <= length <= 80

messages?array<>

Items1 <= items <= 5

headlines?array<>

Items1 <= items <= 5

descriptions?array<>

Items1 <= items <= 2

dailyBudgetCents*integer

creativeIds?array<>

Itemsitems <= 18

creativeId?string

Formatuuid

radiusMi?integer

Range10 <= value <= 50

extraLocations?array<>

Itemsitems <= 10

Response Body

`application/json`

curl -X POST "https://example.com/campaigns" \  -H "Idempotency-Key: stringst" \  -H "Content-Type: application/json" \  -d '{    "dailyBudgetCents": 0  }'

{  "job": {    "id": "string",    "status": "string",    "hold": "string",    "attempts": 0,    "adsWanted": 0,    "adsCreated": 0,    "campaignId": "string",    "liveAt": "string",    "nextRunAt": "string",    "lastError": "string"  }}

Prepare a campaign

202application/json

400application/json

401application/json

402application/json

403application/json

404application/json

409application/json

413application/json

429application/json

500application/json

502application/json

503application/json

Prepare a campaign

202application/json

400application/json

401application/json

402application/json

403application/json

404application/json

409application/json

413application/json

429application/json

500application/json

502application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`