GET /v1/automations/{id}/birthdays
GET
/v1/automations/{id}/birthdays
const url = 'https://seu-endereco-da-api/v1/automations/example/birthdays?period=hoje';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://seu-endereco-da-api/v1/automations/example/birthdays?period=hoje' \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Ler disparos automáticos (automations:read).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”id
required
string
Query Parameters
Seção intitulada “Query Parameters”period
string
Hoje, proximos7 or mes; today by default
Responses
Seção intitulada “Responses”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
diaMes
required
Day and month as –MM-DD
string
idade
required
Null when the stored date has no year
number
emAtendimento
required
Array<object>
object
contactId
required
string
nome
required
string
diaMes
required
Day and month as –MM-DD
string
idade
required
Null when the stored date has no year
number
conversationId
required
string
naoAlcancaveis
required
Array<object>
object
contactId
required
string
nome
required
string
diaMes
required
Day and month as –MM-DD
string
idade
required
Null when the stored date has no year
number
motivo
required
string
Example
{ "naoAlcancaveis": [ { "motivo": "sem_telefone" } ]}