Contatos
A base de contatos da conta: criar, editar, apagar, registrar consentimento, unir
duplicados e importar em lote. Uma API key restrita a alguns números enxerga
só os contatos que têm conversa nesses números, e recebe 403 no que é da base inteira —
exportar, importar, criar, apagar, unir, opt-in e as definições de campos e tags.
Listar contatos
A base de contatos, paginada. Todos os filtros se somam (E).
Criar contato
Cria um contato a partir de um telefone ou de um BSUID. O telefone é normalizado para
Criar ou atualizar contatos em lote
Até 500 contatos por chamada, cada um criado ou atualizado pelo telefone ou BSUID. A
Exportar contatos em CSV
A base inteira — ou o que os filtros selecionarem — num CSV, sem paginação. Uma coluna
Listar importações
Listar importações
Abrir uma importação
Um registro que acompanha uma importação grande feita em vários lotes: mande o `id` em
Consultar uma importação
Consultar uma importação
Encerrar uma importação
Marca a importação como `completed` ou `failed`. Só uma importação ainda em `processing` pode ser encerrada.
Consultar um contato
O contato, com as linhas da lista de supressão que batem com o telefone ou o BSUID dele.
Editar um contato
Campo ausente fica como está; `null` apaga. `attributes` é um patch sobre os valores
Apagar um contato
Apaga o contato de vez, com as conversas, mensagens, tags e histórico — é o pedido de
Registrar opt-in
Registra o consentimento de marketing, com a evidência de como foi obtido. Tira o
Registrar opt-out
Tira o consentimento e põe o telefone e o BSUID do contato na lista de supressão. Dispara `contact.opted_out`.
Unir contatos duplicados
O contato do caminho sobrevive; `duplicateId` é apagado depois de ter conversas, tags,
Histórico do contato
O que aconteceu com o contato, do mais recente ao mais antigo: criação, edições, tags, consentimento, uniões e cliques em campanha.
Exportar os dados de um contato
Tudo o que a conta guarda sobre o contato, num JSON para download — o pedido de acesso da LGPD. Até 10.000 mensagens por conversa.