Criar contato no Chatwoot, por uma API

Cria um contato em uma caixa de entrada da conta. A resposta traz o contato e o contact_inbox com o source_id de que Create conversation precisa.

Identificador
chatwoot_create_contact

A chamada

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "account_id": 1,
    "inbox_id": 1
  }
}

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
account_idintegerSimId of the Chatwoot account: the id of one of the accounts from Get profile, also shown in the dashboard URL after /accounts/, as in app.chatwoot.com/app/accounts/123.
inbox_idnumberSimInbox the contact belongs to, from List inboxes.
namestringNãoName of the contact.
emailstringNãoEmail address of the contact.
phone_numberstringNãoPhone number in international format, with plus sign and country code, such as +5511999999999.
identifierstringNãoUnique id of the contact in your own system.
blockedbooleanNãotrue blocks the contact.
avatar_urlstringNãoURL of a JPEG or PNG image for the avatar of the contact.
additional_attributesobjectNãoFree attributes of the contact, such as city, country or company_name.
custom_attributesobjectNãoCustom attribute values keyed by attribute key. Each key needs a contact custom attribute definition in the account.

Conexões possíveis

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

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

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/chatwoot_create_contact. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Chatwoot

Ver as 15 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.