Skip to main content
POST
Create a click-to-WhatsApp ad

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
accountId
string
required
Required string length: 16
Pattern: ^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ]{16}$
adAccountId
string
required
Minimum string length: 1
name
string
required
Required string length: 1 - 255
budgetAmount
number
required
budgetType
enum<string>
required
Available options:
daily,
lifetime
headline
string
Required string length: 1 - 255
body
string
Minimum string length: 1
imageUrl
string<uri>
video
object
creatives
object[]
Minimum array length: 1
currency
string
Required string length: 3
endDate
string<date-time>
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))$
countries
string[]
Minimum string length: 2
cities
object[]
regions
object[]
zips
object[]
metros
object[]
customLocations
object[]
ageMin
integer
Required range: 13 <= x <= 65
ageMax
integer
Required range: 13 <= x <= 65
interests
object[]
audienceId
string
Minimum string length: 1
advantageAudience
objective
enum<string>
Available options:
OUTCOME_ENGAGEMENT,
OUTCOME_SALES,
OUTCOME_LEADS
bidStrategy
enum<string>
Available options:
LOWEST_COST_WITHOUT_CAP,
LOWEST_COST_WITH_BID_CAP,
COST_CAP,
LOWEST_COST_WITH_MIN_ROAS
bidAmount
number
roasAverageFloor
number
dsaBeneficiary
string
Maximum string length: 100
dsaPayor
string
Maximum string length: 100

Response

Create a click-to-WhatsApp ad completed.

ok
boolean
required
data
object
required