Pular para o conteúdo

POST /v1/automations/reach

POST
/v1/automations/reach
curl --request POST \
--url https://seu-endereco-da-api/v1/automations/reach \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "modelSlug": "example", "segmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "triggerParams": {} }'

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

Media typeapplication/json
object
modelSlug
required
string
segmentId
required
string format: uuid
nullable
triggerParams
object
key
additional properties
any

Example generated

{
"modelSlug": "example",
"segmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"triggerParams": {}
}
Media typeapplication/json
object
reachable
required

Contacts the automation would reach

number
optedOut
required

Contacts left out because they opted out, are blocked or were anonymized

number
missingField
required

Contacts left out because they lack the date field the trigger reads

number
total
required

Live contacts inside the chosen audience

number

Example generated

{
"reachable": 1,
"optedOut": 1,
"missingField": 1,
"total": 1
}