Import de Contato via API

Para importar ou atualizar contatos via API no Cloud Chat, basta enviar uma POST request para https://{{CLOUDCHAT_DOMAIN}}/api/v1/accounts/{{ACCOUNT_ID}}/contacts/external_import enviando a chave de acesso e os campos solicitados abaixo.

Requisição

curl -X POST \ 'https://{{CLOUDCHAT_DOMAIN}}/api/v1/accounts/{{ACCOUNT_ID}}/contacts/external_import' \ --header 'content-type: application/json' \ --header 'api_access_token: API_TOKEN' \ --data --data '{"phone_number": "+5599123456789", "identifier": "CUSTOM_ID", "email": "[email protected]", "name": "Contact Name", "CUSTOM_ATTRIBUTE_1": "123456789", "company_name": "Empresa X", "tags": "tag1, tag2, tag3 [...]"}'

Parâmetros

CLOUDCHAT_DOMAIN: Você pode obter seu domínio ao fazer login na sua conta no CloudChat. É a parte que aparece na URL do navegador:

ACCOUNT_ID: Obtido na seção de configurações da conta:

API_TOKEN: Obtido nas configurações do perfil (https://{{CLOUDCHAT_DOMAIN}}/app/accounts/ACCOUNT_ID/profile/settings)

Corpo da requisição

O corpo da requisição possui os seguintes campos, onde pelo menos um dentre os campos phone_number, identifier e email deve estar presente.

Obs.: Campos customizados podem ser adicionados no corpo da requisição livremente utilizando a chave obtidada na aba de gerenciamento de Atributos Personalizados:

Tags são similarmente adicionadas ao contato inserindo seus nomes em uma lista separada por vírgulas no campo tags.