Contacts and companies

add_contact_memory

Write

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).

Permission

contacts:write

Operation

contact_memory.add

Parameters

contactIdstringrequired

kindstringrequired

PREFERENCEFACTHISTORYRELATIONSHIPRESTRICTION

contentstringrequired

expiresAtstring (date-time)optional

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

add_contacts_to_company

Write

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

Permission

contacts:write

Operation

companies.contacts.add

Parameters

companyIdstringrequired

contactIdsstring[]required

add_note

Write

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.

Permission

contacts:write

Operation

notes.create

Parameters

contactIdstringoptional

companyIdstringoptional

bodystringrequired

add_tag_to_contact

Write

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

Permission

contacts:write

Operation

contacts.tags.add

Parameters

contactIdstringrequired

tagIdstringrequired

create_company

Write

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

Permission

contacts:write

Operation

companies.create

Parameters

domainstringoptional

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

taxIdstringoptional

CNPJ, com ou sem pontuação.

websitestringoptional

phonestringoptional

industrystringoptional

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

sizestringoptional

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

citystringoptional

statestringoptional

countrystringoptional

notesstringoptional

ownerIdstringoptional

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

namestringrequired

create_contact

Write

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.

Permission

contacts:write

Operation

contacts.create

Parameters

namestringrequired

emailstringoptional

phonestringoptional

Telefone, de preferência +5511999999999.

customFieldsobjectoptional

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

Write

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.

Permission

contacts:write

Operation

custom_fields.create

Parameters

entitystringoptional

De quem é o campo.contactdealcompany

namestringrequired

Nome que aparece na tela.

keystringoptional

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

typestringoptional

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

optionsstring[]optional

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

requiredbooleanoptional

orderintegeroptional

dealTemplateIdstringoptional

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

delete_company

Write

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

Permission

contacts:write

Operation

companies.delete

Parameters

companyIdstringrequired

delete_contact

Write

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

Permission

contacts:write

Operation

contacts.delete

Parameters

contactIdstringrequired

forget_contact_memory

Write

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

Permission

contacts:write

Operation

contact_memory.forget

Parameters

contactIdstringrequired

memoryIdstringrequired

get_company

Read

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

Permission

contacts:read

Operation

companies.get

Parameters

companyIdstringrequired

get_company_timeline

Read

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

Permission

contacts:read

Operation

companies.timeline

Parameters

companyIdstringrequired

categoriesstring[]optional

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

cursorstringoptional

nextCursor da página anterior.

limitintegeroptional

get_contact

Read

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

Permission

contacts:read

Operation

contacts.get

Parameters

contactIdstringrequired

get_contact_timeline

Read

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.

Permission

contacts:read

Operation

contacts.timeline

Parameters

contactIdstringrequired

categoriesstring[]optional

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

cursorstringoptional

nextCursor da página anterior.

limitintegeroptional

get_lead_score

Read

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.

Permission

contacts:read

Operation

contacts.score

Parameters

contactIdstringrequired

list_companies

Read

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

Permission

contacts:read

Operation

companies.list

Parameters

searchstringoptional

pageintegeroptional

limitintegeroptional

list_contact_memories

Read

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.

Permission

contacts:read

Operation

contact_memory.list

Parameters

contactIdstringrequired

list_custom_fields

Read

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.

Permission

contacts:read

Operation

custom_fields.list

Parameters

entitystringrequired

De quem é o campo.contactdealcompany

dealTemplateIdstringoptional

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

list_tags

Read

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

Permission

contacts:read

Operation

tags.list

Parameters

No parameters.

remove_contact_from_company

Write

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

Permission

contacts:write

Operation

companies.contacts.remove

Parameters

companyIdstringrequired

contactIdstringrequired

remove_tag_from_contact

Write

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

Permission

contacts:write

Operation

contacts.tags.remove

Parameters

contactIdstringrequired

tagIdstringrequired

restore_contact

Write

Restaura um contato excluído.

Permission

contacts:write

Operation

contacts.restore

Parameters

contactIdstringrequired

search_contacts

Read

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.

Permission

contacts:read

Operation

contacts.search

Parameters

searchstringoptional

tagIdsstring[]optional

Contatos com pelo menos uma destas etiquetas.

hasEmailbooleanoptional

hasPhonebooleanoptional

assignedToIdstringoptional

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

createdFromstringoptional

Cadastrados a partir de.

createdTostringoptional

Cadastrados até.

sortBystringoptional

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

sortOrderstringoptional

ascdesc

pageintegeroptional

limitintegeroptional

set_company_custom_fields

Write

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

Permission

contacts:write

Operation

companies.custom_fields.set

Parameters

companyIdstringrequired

valuesobjectrequired

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

Write

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

Permission

contacts:write

Operation

contacts.custom_fields.set

Parameters

contactIdstringrequired

valuesobjectrequired

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

Write

Altera os dados de uma empresa. Campo nulo limpa.

Permission

contacts:write

Operation

companies.update

Parameters

domainstringoptional

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

taxIdstringoptional

CNPJ, com ou sem pontuação.

websitestringoptional

phonestringoptional

industrystringoptional

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

sizestringoptional

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

citystringoptional

statestringoptional

countrystringoptional

notesstringoptional

ownerIdstringoptional

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

companyIdstringrequired

namestringoptional

update_contact

Write

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.

Permission

contacts:write

Operation

contacts.update

Parameters

contactIdstringrequired

namestringoptional

emailstringoptional

phonestringoptional

customFieldsobjectoptional

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

Write

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.

Permission

contacts:write

Operation

custom_fields.update

Parameters

entitystringoptional

De quem é o campo.contactdealcompany

keystringrequired

Chave do campo (list_custom_fields).

namestringoptional

typestringoptional

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

optionsstring[]optional

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

requiredbooleanoptional

orderintegeroptional