Documentacao da API IAra
🪪

Contatos e identificadores

2 artigos Suporte Por Suporte

Criar, buscar, atualizar, filtrar, mesclar contatos e vincular contatos a caixas de entrada.

Contatos: criar, listar, buscar e atualizar

Contatos: criar, listar, buscar e atualizar Contatos representam pessoas atendidas pela IAra. Use identifier para vincular o contato ao ID do seu sistema externo. Criar contato curl -X POST "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/contacts" \ -H "api_access_token: $API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Maria Cliente", "email": "[email protected]", "phone_number": "+5554999999999", "identifier": "crm-12345", "custom_attributes": {"origem":"digi2b.com"} }' Listar e buscar curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/contacts" \ -H "api_access_token: $API_TOKEN" curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/contacts/[email protected]" \ -H "api_access_token: $API_TOKEN" Atualizar curl -X PUT "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/contacts/123" \ -H "api_access_token: $API_TOKEN" \ -H "Content-Type: application/json" \ -d '{"name":"Maria Cliente", "custom_attributes":{"plano":"premium"}}' Boas praticas Busque antes de criar, normalize telefone com DDI e mantenha identifier estavel. Evite criar duplicidade quando o mesmo contato chega por canais diferentes.

Contatos: filtros, labels, merge e contact inboxes

Contatos: filtros, labels, merge e contact inboxes A API de contatos tambem cobre filtros, etiquetas, mesclagem e relacao entre contato e caixa de entrada. Filtros de contato Use /contacts/filter para consultas estruturadas quando a busca simples nao for suficiente. Exemplos: contatos por atributo, canal, data ou estado de cadastro. Etiquetas do contato curl -X POST "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/contacts/123/labels" \ -H "api_access_token: $API_TOKEN" \ -H "Content-Type: application/json" \ -d '{"labels":["cliente-premium", "api"]}' A atualizacao de labels pode substituir a lista existente. Leia a resposta e preserve etiquetas que nao devem ser removidas. Contactable inboxes Use /contacts/:id/contactable_inboxes para descobrir em quais caixas o contato pode ser acionado. curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/contacts/123/contactable_inboxes" \ -H "api_access_token: $API_TOKEN" Contact inbox Use /contacts/:id/contact_inboxes para criar vinculo entre contato e inbox quando o fluxo exigir e o usuario tiver permissao. Merge Use merge apenas quando tiver certeza de que dois contatos representam a mesma pessoa. Depois da mesclagem, o contato secundario e removido. Cuidados Mesclagem e etiquetas afetam a operacao do atendimento. Registre quem fez a alteracao, IDs envolvidos e motivo.