Skip to main content
POST
Plan a sandbox inventory-source test campaign

Authorizations

Authorization
string
header
required

API key or access token

Body

application/json
sandbox
enum<boolean>
required
Available options:
true
sourceId
string
required
Minimum string length: 1
forceRefresh
boolean
sellerSandboxReady
boolean
advertiserDomain
string
Pattern: ^(?=.{1,253}$)([a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,}$
advertiserId
integer
Required range: 1 <= x <= 9007199254740991
campaignBrief
string
Required string length: 1 - 10000
budget
number
Required range: x > 0
currency
string
Pattern: ^[A-Za-z]{3}$
flightStart
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
flightEnd
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
packages
object[]
Minimum array length: 1
maxCandidates
integer
Required range: 1 <= x <= 10
sourceName
string
Minimum string length: 1

Response

Plan a sandbox inventory-source test campaign

confirmation
object
required
{key}
any