Skip to main content
POST
Create an 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
campaignName
string
Required string length: 1 - 255
adSetName
string
Required string length: 1 - 255
adName
string
Required string length: 1 - 255
goal
enum<string>
Available options:
engagement,
traffic,
awareness,
video_views,
lead_generation,
lead_conversion,
conversions,
app_promotion,
catalog_sales
budgetAmount
number
budgetType
enum<string>
Available options:
daily,
lifetime
currency
string
Minimum string length: 1
headline
string
Required string length: 1 - 400
longHeadline
string
Required string length: 1 - 90
body
string
Required string length: 1 - 500
description
string
Required string length: 1 - 255
callToAction
string
Minimum string length: 1
imageUrl
string<uri>
video
object
images
object
creatives
object[]
Minimum array length: 1
adSetId
string
Minimum string length: 1
businessName
string
Required string length: 1 - 25
boardId
string
Minimum string length: 1
organizationId
string
Minimum string length: 1
countries
string[]
Minimum string length: 2
ageMin
integer
Required range: 13 <= x <= 65
ageMax
integer
Required range: 13 <= x <= 65
interests
object[]
startDate
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))$
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))$
campaignType
enum<string>
Available options:
display,
search
keywords
string[]
Minimum string length: 1
promotedObject
object
tracking
object

Response

Create an ad completed.

ok
boolean
required
data
object
required