v1Resources/Paid Boosts/postCreate a boost
Create a boost
Boosts a post with paid ad spend through a connected ad account. This spends real money, so a budget and a duration are always required: a saved boost config only supplies defaults, never a budget. Pass postSubmissionId to boost an already-published post now, or postId with platform or connectionId to queue a boost that starts once the post goes live. A daily budget above 500,000 minor units or a duration over 90 days is refused.
post
boosts:write/api/v1/boostsRequest body
postSubmissionIdstringoptional
An already-published post's submission id. Use this or postId, not both.
postIdstringoptional
A not-yet-published post's id. Needs platform or connectionId.
platformstringoptional
Which platform submission to boost when using postId, for example facebook.
connectionIdstringoptional
The exact connection to boost when using postId. Preferred over platform.
boostConfigIdstringoptional
A saved boost config to take the ad account, targeting, publisher platforms and delay from. Its budget is not used.
adAccountIdstringoptional
The ad account to spend from. Required unless the boost config supplies one.
targetingobjectoptional
The audience targeting.
dailyBudgetintegerrequired
The daily budget in minor currency units, for example 2500 for 25.00 a day. Greater than 0 and at most 500,000.
durationDaysintegerrequired
How many days the boost runs, 1 to 90.
delayHoursnumberoptional
Hours to wait after the post goes live before spend starts.
publisherPlatformsarray of stringoptional
Platform surfaces to run on, for example facebook and instagram.
scheduledStartstringoptional
An exact date-time to start spend at, instead of a delay.
Response
dataobjectoptional
adRunIdstringoptional
The new boost's id.
adSetIdstringoptional
Its ad set's id.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/boosts
Your API key
Request body*
{
"data": {
"adRunId": "run_123",
"adSetId": "set_123"
}
}