Pular para o conteúdo

GET /v1/automations/birthdays

GET
/v1/automations/birthdays
curl --request GET \
--url 'https://seu-endereco-da-api/v1/automations/birthdays?period=hoje' \
--header 'Authorization: Bearer <token>'

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

period
string
Allowed values: hoje proximos7 mes

Hoje, proximos7 or mes; today by default

channelId
string format: uuid

The number the send would leave by, which decides who is reachable

Media typeapplication/json
object
total
required

The three buckets added up, counted in the database, never the array lengths

number
totalEnviaveis
required

How many get a message, counted in the database

number
totalEmAtendimento
required
number
totalNaoAlcancaveis
required
number
truncado
required

True when the period holds more people than one page carries

boolean
enviaveis
required
Array<object>
object
contactId
required
string
nome
required
string
nullable
diaMes
required

Day and month as –MM-DD

string
idade
required

Null when the stored date has no year

number
nullable
emAtendimento
required
Array<object>
object
contactId
required
string
nome
required
string
nullable
diaMes
required

Day and month as –MM-DD

string
idade
required

Null when the stored date has no year

number
nullable
conversationId
required
string
naoAlcancaveis
required
Array<object>
object
contactId
required
string
nome
required
string
nullable
diaMes
required

Day and month as –MM-DD

string
idade
required

Null when the stored date has no year

number
nullable
motivo
required
string
Allowed values: sem_telefone sem_consentimento anonimizado bloqueado

Example

{
"naoAlcancaveis": [
{
"motivo": "sem_telefone"
}
]
}