v1Recursos/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/boostsCorpo da solicitação
postSubmissionIdstringopcional
An already-published post's submission id. Use this or postId, not both.
postIdstringopcional
A not-yet-published post's id. Needs platform or connectionId.
platformstringopcional
Which platform submission to boost when using postId, for example facebook.
connectionIdstringopcional
The exact connection to boost when using postId. Preferred over platform.
boostConfigIdstringopcional
A saved boost config to take the ad account, targeting, publisher platforms and delay from. Its budget is not used.
adAccountIdstringopcional
The ad account to spend from. Required unless the boost config supplies one.
targetingobjectopcional
The audience targeting.
dailyBudgetintegerobrigatório
The daily budget in minor currency units, for example 2500 for 25.00 a day. Greater than 0 and at most 500,000.
durationDaysintegerobrigatório
How many days the boost runs, 1 to 90.
delayHoursnumberopcional
Hours to wait after the post goes live before spend starts.
publisherPlatformsarray of stringopcional
Platform surfaces to run on, for example facebook and instagram.
scheduledStartstringopcional
An exact date-time to start spend at, instead of a delay.
Resposta
dataobjectopcional
adRunIdstringopcional
The new boost's id.
adSetIdstringopcional
Its ad set's id.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/boosts
Sua chave de API
Corpo da solicitação*
{
"data": {
"adRunId": "run_123",
"adSetId": "set_123"
}
}