Pular para o conteúdo

POST /v1/automations/birthdays/send

POST
/v1/automations/birthdays/send
curl --request POST \
--url https://seu-endereco-da-api/v1/automations/birthdays/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "contactIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "channelId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "templateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "templateVariables": [ "example" ], "headerMediaKey": "example", "headerMediaMime": "example" }'

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

Media typeapplication/json
object
contactIds
required
Array<string>
>= 1 items
channelId
required
string format: uuid
templateId
required
string format: uuid
templateVariables
Array<string>
headerMediaKey
string
headerMediaMime
string

Example generated

{
"contactIds": [
"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
],
"channelId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"templateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"templateVariables": [
"example"
],
"headerMediaKey": "example",
"headerMediaMime": "example"
}
Media typeapplication/json
object
campaignId
required

The campaign the send became; null when nobody was left to greet

string
nullable
contactIds
required

Who the greeting actually went to

Array<string>
puladosForaDoPublico
required

Left out for not belonging to the audience of this send, or for not being a contact of this account

Array<string>
puladosEmAtendimento
required

Left out for talking to an agent right now

Array<string>
puladosJaParabenizados
required

Left out for having been greeted already today

Array<string>

Example generated

{
"campaignId": "example",
"contactIds": [
"example"
],
"puladosForaDoPublico": [
"example"
],
"puladosEmAtendimento": [
"example"
],
"puladosJaParabenizados": [
"example"
]
}