Criar contato no Intercom, por uma API

Cria um contato, usuário ou lead. Envie ao menos um entre email, external_id ou role. Todo atributo customizado enviado já deve existir no workspace, ou o Intercom recusa o contato.

Identificador
intercom_create_contact

A chamada

POST https://connect.reportei.com/api/tools/intercom_create_contact/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "role": "<role>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
rolestringNãolead creates a lead; user, or any other value, creates a user.
external_idstringNãoUnique id of the contact in your own system.
emailstringNãoEmail address of the contact.
phonestringNãoPhone number of the contact.
namestringNãoName of the contact.
avatarstringNãoURL of an image used as the avatar of the contact.
signed_up_atintegerNãoWhen the contact signed up, as a Unix timestamp in seconds.
last_seen_atintegerNãoWhen the contact was last seen, as a Unix timestamp in seconds.
owner_idstringNãoId of the teammate who owns the contact, from List admins.
unsubscribed_from_emailsbooleanNãotrue if the contact unsubscribed from emails.
language_overridestringNãoPreferred language of the contact for the Messenger, such as pt-BR or en.
custom_attributesobjectNãoCustom attribute values keyed by attribute name. Each attribute must already exist in the workspace.

Conexões possíveis

O seu cliente conecta a conta do Intercom uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/intercom, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/intercom_create_contact. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Intercom

Ver as 13 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.