Pular para o conteúdo

POST /v1/campaigns/{id}/schedule

POST
/v1/campaigns/{id}/schedule
curl --request POST \
--url https://seu-endereco-da-api/v1/campaigns/example/schedule \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "scheduledAt": "example" }'

Permissão que a Chave de acesso precisa: Criar e disparar campanhas (campaigns:manage).

id
required
string
Media typeapplication/json
object
scheduledAt
required
string

Example generated

{
"scheduledAt": "example"
}
Media typeapplication/json
object
id
required
string
name
required
string
kind
required
string
Allowed values: template gateway email sms
channelId
required
string
channel
required
object
name
required

O nome que o cliente deu ao canal na plataforma

string
provider
required
string
status
required
string
coexistence
required
boolean
phoneNumber
required

O numero ou @ da conta no provedor

string
nullable
accountName
required

O nome da conta no provedor: o verificado da Meta, ou o do aparelho no canal lite

string
nullable
removed
required

O canal foi apagado; a conversa continua descrevendo por onde ela aconteceu

boolean
templateId
required
string
nullable
templateName
required
string
nullable
templateVariables
required

Each item is a fixed text or { field, fallback } bound to a contact field

Array<object>
object
headerMediaKey
required
string
nullable
headerMediaMime
required
string
nullable
headerMediaUrl

Temporary link to the header media; only on the single-campaign read

string
nullable
gatewaySteps
required
Array<object>
nullable
object
id
required
string
kind
required
string
Allowed values: text image document
text
string
mediaKey
string
mediaMime
string
fileName
string
delaySec
required
number
gatewayConfig
required
object
gapMin
required
number
gapMax
required
number
dailyLimit
required
number
businessHours
required
boolean
businessHoursConfigId
string
rotationChannelIds
required
Array<string>
nullable
rotationMode
required
string
nullable
rotationSwitchEvery
required
number
nullable
emailTemplateId
required
string
nullable
subject
required

Subject typed for the campaign; empty means the template subject

string
nullable
smsBody
required
string
nullable
optOutKeywords
required
Array<string>
segmentId
required

Segmento salvo de que este publico veio; a campanha guarda a propria copia da regra

string
nullable
audienceFilter
required

A regra de publico guardada na campanha; nula quando vai para a base inteira

object
audienceCount
required
number
audienceEstimated
required
boolean
status
required
string
displayStatus
required

Status para mostrar: a campanha concluida em que todo envio falhou vira failed, e a que teve parte das falhas vira completed_with_failures

string
Allowed values: draft scheduled queued running paused completed completed_with_failures failed canceled
deliveryRate
required

Entregues / (entregues + falhas), de 0 a 1; nula sem nenhum envio concluido

number
nullable
replyRate
required

Quem respondeu depois de receber / entregues, de 0 a 1; nula sem entregues

number
nullable
scheduledAt
required
string format: date-time
nullable
startedAt
required
string format: date-time
nullable
completedAt
required
string format: date-time
nullable
stopOnReply
required
boolean
optimizedMarketing
required
boolean
handoffFlowId
required
string
nullable
openedCount
required
number
clickedCount
required
number
bouncedCount
required
number
spamCount
required
number
unsubscribedCount
required
number
skippedCount
required

Recipients left out when the audience was materialized: no address, suppressed, blocked or duplicated

number
pausedReason
required

Why a broadcast campaign paused itself: insufficient_funds, bounce_rate, spam_rate or provider_auth

string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
funnel
required
object
pending
required
number
queued
required
number
held
required

Mensagem presa: o numero esta desconectado ou ainda nao enviou

number
sent
required
number
delivered
required
number
read
required
number
failed
required
number
replied
required
number
reached
required

Quem recebeu: entregue, lida, parou por ter respondido ou respondeu

number
lost
required

Quem nao recebeu: falhou sem nunca ter respondido

number
total
required
number
costCents
required

Custo em centavos, pela mesma conta do relatorio de campanhas

number
aiAction

Present on the detail: what the AI did to create this campaign, if it did.

object
sentViaMarketingApi

Present on the detail: whether any message of this campaign really went through the Meta marketing API.

boolean

Example

{
"kind": "template",
"gatewaySteps": [
{
"kind": "text"
}
],
"displayStatus": "draft"
}