Contatos e empresas

add_contact_memory

Escrita

Anota algo que a IA deve lembrar sobre o contato nas próximas conversas. Uma frase curta e verdadeira; nada de dado sensível (saúde, documento, senha).

Permissão

contacts:write

Operação

contact_memory.add

Parâmetros

contactIdstringobrigatório

kindstringobrigatório

PREFERENCEFACTHISTORYRELATIONSHIPRESTRICTION

contentstringobrigatório

expiresAtstring (date-time)opcional

Quando deixa de valer (ISO), para algo passageiro.

add_contacts_to_company

Escrita

Põe contatos numa empresa (tirando da anterior). Os negócios abertos deles sem empresa passam a ser dela.

Permissão

contacts:write

Operação

companies.contacts.add

Parâmetros

companyIdstringobrigatório

contactIdsstring[]obrigatório

add_note

Escrita

Registra uma nota na linha do tempo de um contato ou de uma empresa (informe um dos dois). Use para guardar o que foi combinado ou observado.

Permissão

contacts:write

Operação

notes.create

Parâmetros

contactIdstringopcional

companyIdstringopcional

bodystringobrigatório

add_tag_to_contact

Escrita

Etiqueta um contato (repetir não faz nada). Dispara as automações e jornadas de etiqueta adicionada. Ids das etiquetas em list_tags.

Permissão

contacts:write

Operação

contacts.tags.add

Parâmetros

contactIdstringobrigatório

tagIdstringobrigatório

create_company

Escrita

Cadastra uma empresa. Com domínio, os contatos sem empresa que têm e-mail desse domínio entram nela.

Permissão

contacts:write

Operação

companies.create

Parâmetros

domainstringopcional

Domínio do site/e-mail (acme.com.br). Liga sozinho os contatos @acme.com.br.

taxIdstringopcional

CNPJ, com ou sem pontuação.

websitestringopcional

phonestringopcional

industrystringopcional

Setor (ex.: Varejo, Saúde, Indústria).

sizestringopcional

Faixa de funcionários (ex.: 1-10, 11-50, 51-200, 201-500, 500+).

citystringopcional

statestringopcional

countrystringopcional

notesstringopcional

ownerIdstringopcional

Responsável pela conta (usuário da equipe).

namestringobrigatório

create_contact

Escrita

Cadastra um contato, já com campos personalizados se quiser. Se já existe um contato com o mesmo telefone, devolve esse (e grava nele os campos informados) em vez de duplicar.

Permissão

contacts:write

Operação

contacts.create

Parâmetros

namestringobrigatório

emailstringopcional

phonestringopcional

Telefone, de preferência +5511999999999.

customFieldsobjectopcional

Valores por chave do campo (veja list_custom_fields). Número aceita "850.000" ou "1.250,50"; data AAAA-MM-DD ou DD/MM/AAAA; seleção, uma das opções. null apaga.

create_custom_field

Escrita

Cria um campo personalizado (de contato, negócio ou empresa). A chave é o nome do campo na API e nas variáveis: sem `key`, sai do nome (ex.: "Data de nascimento" → data_de_nascimento) e não muda depois.

Permissão

contacts:write

Operação

custom_fields.create

Parâmetros

entitystringopcional

De quem é o campo.contactdealcompany

namestringobrigatório

Nome que aparece na tela.

keystringopcional

Chave fixa do campo; sem ela, sai do nome.

typestringopcional

text, number, date (AAAA-MM-DD) ou select (escolha entre as opções).textnumberdateselect

optionsstring[]opcional

Só para select: as opções, na ordem em que aparecem.

requiredbooleanopcional

orderintegeropcional

dealTemplateIdstringopcional

Só negócio: o campo vale só para os negócios deste modelo.

delete_company

Escrita

Apaga uma empresa. Os contatos e negócios ficam, só sem empresa. Exige o id exato.

Permissão

contacts:write

Operação

companies.delete

Parâmetros

companyIdstringobrigatório

delete_contact

Escrita

Exclui um contato (vai para a lixeira e pode ser restaurado com restore_contact). A memória da IA sobre ele é apagada de vez.

Permissão

contacts:write

Operação

contacts.delete

Parâmetros

contactIdstringobrigatório

forget_contact_memory

Escrita

Faz a IA esquecer um item da memória do contato (errado ou que não vale mais).

Permissão

contacts:write

Operação

contact_memory.forget

Parâmetros

contactIdstringobrigatório

memoryIdstringobrigatório

get_company

Leitura

Detalhe de uma empresa: dados, responsável, contatos e negócios (os mais recentes).

Permissão

contacts:read

Operação

companies.get

Parâmetros

companyIdstringobrigatório

get_company_timeline

Leitura

Linha do tempo da empresa: o que aconteceu com ela e com todos os contatos dela, do mais recente para o mais antigo.

Permissão

contacts:read

Operação

companies.timeline

Parâmetros

companyIdstringobrigatório

categoriesstring[]opcional

Filtra por categoria: conversation, deal, schedule, marketing, support, note, contact.

cursorstringopcional

nextCursor da página anterior.

limitintegeropcional

get_contact

Leitura

Detalhe de um contato: conversas, negócios e agendamentos recentes, etiquetas e campos personalizados.

Permissão

contacts:read

Operação

contacts.get

Parâmetros

contactIdstringobrigatório

get_contact_timeline

Leitura

Linha do tempo do contato, do mais recente para o mais antigo: conversas, negócios, propostas, pagamentos, agenda, formulários, campanhas, e-mails, tickets e notas.

Permissão

contacts:read

Operação

contacts.timeline

Parâmetros

contactIdstringobrigatório

categoriesstring[]opcional

Filtra por categoria: conversation, deal, schedule, marketing, support, note, contact.

cursorstringopcional

nextCursor da página anterior.

limitintegeropcional

get_lead_score

Leitura

Score do lead (0–100) com temperatura (quente, morno ou frio), a frase que explica a nota, os motivos (positivos e negativos) e o próximo passo sugerido. Use para priorizar contatos ou explicar por que um lead está quente ou frio.

Permissão

contacts:read

Operação

contacts.score

Parâmetros

contactIdstringobrigatório

list_companies

Leitura

Lista empresas (contas B2B) do CRM, com busca por nome, domínio ou CNPJ, e quantos contatos e negócios abertos cada uma tem.

Permissão

contacts:read

Operação

companies.list

Parâmetros

searchstringopcional

pageintegeropcional

limitintegeropcional

list_contact_memories

Leitura

O que a IA lembra de um contato: preferências, fatos, histórico, relações e restrições (ex.: alérgico, prefere WhatsApp à tarde), de onde veio cada item e até quando vale.

Permissão

contacts:read

Operação

contact_memory.list

Parâmetros

contactIdstringobrigatório

list_custom_fields

Leitura

Campos personalizados da empresa (chave, nome, tipo, opções), de contato ou de negócio. Use antes de gravar valores, para saber as chaves e os formatos.

Permissão

contacts:read

Operação

custom_fields.list

Parâmetros

entitystringobrigatório

De quem é o campo.contactdealcompany

dealTemplateIdstringopcional

Só negócio: os campos gerais mais os deste modelo.

list_tags

Leitura

Etiquetas da empresa (id, nome, cor), para etiquetar contatos e conversas.

Permissão

contacts:read

Operação

tags.list

Parâmetros

Sem parâmetros.

remove_contact_from_company

Escrita

Tira um contato da empresa (o contato continua no CRM).

Permissão

contacts:write

Operação

companies.contacts.remove

Parâmetros

companyIdstringobrigatório

contactIdstringobrigatório

remove_tag_from_contact

Escrita

Tira uma etiqueta de um contato (se não tinha, não faz nada).

Permissão

contacts:write

Operação

contacts.tags.remove

Parâmetros

contactIdstringobrigatório

tagIdstringobrigatório

restore_contact

Escrita

Restaura um contato excluído.

Permissão

contacts:write

Operação

contacts.restore

Parâmetros

contactIdstringobrigatório

search_contacts

Leitura

Lista ou busca contatos da empresa por nome, telefone ou e-mail, com filtro por etiquetas e por ter e-mail/telefone. Mais recentes primeiro (ou pela ordem pedida), paginado.

Permissão

contacts:read

Operação

contacts.search

Parâmetros

searchstringopcional

tagIdsstring[]opcional

Contatos com pelo menos uma destas etiquetas.

hasEmailbooleanopcional

hasPhonebooleanopcional

assignedToIdstringopcional

Contatos de uma pessoa da equipe (conversa ou negócio atribuído a ela).

createdFromstringopcional

Cadastrados a partir de.

createdTostringopcional

Cadastrados até.

sortBystringopcional

Ordenar por nome, data de cadastro ou última alteração (padrão).namecreatedAtupdatedAt

sortOrderstringopcional

ascdesc

pageintegeropcional

limitintegeropcional

set_company_custom_fields

Escrita

Grava campos personalizados de uma empresa (só os informados mudam; null apaga). Valor fora do tipo recusa tudo e diz o motivo.

Permissão

contacts:write

Operação

companies.custom_fields.set

Parâmetros

companyIdstringobrigatório

valuesobjectobrigatório

Valores por chave do campo (veja list_custom_fields). Número aceita "850.000" ou "1.250,50"; data AAAA-MM-DD ou DD/MM/AAAA; seleção, uma das opções. null apaga.

set_contact_custom_fields

Escrita

Grava campos personalizados de um contato (só os informados mudam; null apaga). Valor fora do tipo recusa tudo e diz o motivo.

Permissão

contacts:write

Operação

contacts.custom_fields.set

Parâmetros

contactIdstringobrigatório

valuesobjectobrigatório

Valores por chave do campo (veja list_custom_fields). Número aceita "850.000" ou "1.250,50"; data AAAA-MM-DD ou DD/MM/AAAA; seleção, uma das opções. null apaga.

update_company

Escrita

Altera os dados de uma empresa. Campo nulo limpa.

Permissão

contacts:write

Operação

companies.update

Parâmetros

domainstringopcional

Domínio do site/e-mail (acme.com.br). Liga sozinho os contatos @acme.com.br.

taxIdstringopcional

CNPJ, com ou sem pontuação.

websitestringopcional

phonestringopcional

industrystringopcional

Setor (ex.: Varejo, Saúde, Indústria).

sizestringopcional

Faixa de funcionários (ex.: 1-10, 11-50, 51-200, 201-500, 500+).

citystringopcional

statestringopcional

countrystringopcional

notesstringopcional

ownerIdstringopcional

Responsável pela conta (usuário da equipe).

companyIdstringobrigatório

namestringopcional

update_contact

Escrita

Altera nome, e-mail, telefone ou campos personalizados de um contato. E-mail ou telefone nulos limpam; nos campos, só os informados mudam e null apaga.

Permissão

contacts:write

Operação

contacts.update

Parâmetros

contactIdstringobrigatório

namestringopcional

emailstringopcional

phonestringopcional

customFieldsobjectopcional

Valores por chave do campo (veja list_custom_fields). Número aceita "850.000" ou "1.250,50"; data AAAA-MM-DD ou DD/MM/AAAA; seleção, uma das opções. null apaga.

update_custom_field

Escrita

Altera um campo personalizado pela chave: nome, tipo, opções, obrigatório ou ordem. A chave e de quem é o campo não mudam. Mudar o tipo reconverte os valores já gravados.

Permissão

contacts:write

Operação

custom_fields.update

Parâmetros

entitystringopcional

De quem é o campo.contactdealcompany

keystringobrigatório

Chave do campo (list_custom_fields).

namestringopcional

typestringopcional

text, number, date (AAAA-MM-DD) ou select (escolha entre as opções).textnumberdateselect

optionsstring[]opcional

Só para select: as opções, na ordem em que aparecem.

requiredbooleanopcional

orderintegeropcional