Pular para o conteúdo

POST /v1/automations/{id}/start

POST
/v1/automations/{id}/start
curl --request POST \
--url https://seu-endereco-da-api/v1/automations/example/start \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Gerenciar disparos automáticos (automations:manage).

id
required
string
Media typeapplication/json
object
id
required
string
name
required
string
recipe
required

The recipe the automation was created from

string
status
required
string
Allowed values: rascunho ativa pausada
audience
required

Null means the whole reachable base of the account

object
id
required
string
name
required
string
contactCount
required

How many contacts the audience held when it was last counted

number
nullable
countedAt
required

When that count was taken

string format: date-time
nullable
modelSlug
required

Slug of the library model the automation came from

string
objective
required

Objective of the library model, null when the model states none

string
nullable
channelKind
required

Whether the number sends through the official WhatsApp API

string
Allowed values: oficial nao_oficial
nextRunAt
required

When it goes out next; null while the automation is a draft or paused

string format: date-time
nullable
editedByHand
required

True once somebody changed the flow in the builder, so the screen stopped writing over it

boolean
createdAt
required
string format: date-time
channelId
required
string
templateId
required

Null when the message is free text

string
nullable
messageText
required

The free text sent on numbers that are not official

string
nullable
templateVariables
required
Array<string>
headerMediaKey
required
string
nullable
headerMediaMime
required
string
nullable
schedule
required

Null on automations that start from an event

object
scheduleKind
required
string
Allowed values: once daily weekly monthly yearly
timezone
required

The account’s business timezone, resolved when the automation was saved

string
localTime

Local time of day, HH:MM

string
weekdays

0 is Sunday

Array<number>
dayOfMonth
number
month

1 to 12, only on a yearly schedule

number
daysBefore

0 to 365, only on the date of each person

number
triggerParams
required

The trigger parameters the automation was saved with; null on those created before models

object
when
required

The answer given to when the send goes out

string
Allowed values: na_data_de_cada_pessoa diario semanal mensal anual deal_stage_change deal_stale negocio_ganho contato_criado
dateFieldKey
required

The contact date field the send follows: each person’s own date, or the window a cadence cuts the audience by

string
nullable

Example

{
"status": "rascunho",
"channelKind": "oficial",
"schedule": {
"scheduleKind": "once"
},
"when": "na_data_de_cada_pessoa"
}