Skip to main content
POST
Start a placement test

Authorizations

Authorization
string
header
required

Your Mailercloud API key (plain text, no Bearer prefix). Create keys in Settings → API.

Headers

Content-Type
string
default:application/json
required

Request body type

Body

application/json
campaign_id
string
required

Draft campaign id, as returned by the Campaigns API.

provider_ids
string[]
required

Provider ids from List placement providers.

Required array length: 1 - 100 elements
confirm_unchanged
boolean
default:false

Run again even though the draft has not changed since its last test.

Response

Test started.

data
object