API Publica

API publica para integracoes de terceiros e widgets embarcados. Nao requer autenticacao de usuario — usa o identificador do inbox.

Autenticacao

A API publica usa o inbox_identifier no path para identificar o inbox. O contato usa um contact_identifier retornado na criacao.

Contatos

POST/public/api/v1/inboxes/{inbox_identifier}/contacts

Cria um novo contato no inbox publico.

Body

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Nao	Nome do contato
`email`	`string`	Nao	Email
`phone_number`	`string`	Nao	Telefone
`identifier`	`string`	Nao	Identificador externo
`custom_attributes`	`object`	Nao	Atributos personalizados

bash

curl -X POST "https://chat.seudominio.com/public/api/v1/inboxes/INBOX_IDENTIFIER/contacts" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Visitante do Site",
    "email": "visitante@email.com"
  }'

200Contato criado

json

{
  "source_id": "contact_source_abc123",
  "pubsub_token": "token_for_websocket"
}

GET/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}

Obtem dados de um contato pelo identificador.

PATCH/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}

Atualiza dados de um contato publico.

Conversas

POST/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations

Cria uma nova conversa para o contato.

Body

Nome	Tipo	Obrigatorio	Descricao
`custom_attributes`	`object`	Nao	Atributos da conversa

bash

curl -X POST "https://chat.seudominio.com/public/api/v1/inboxes/INBOX_ID/contacts/CONTACT_ID/conversations" \
  -H "Content-Type: application/json" \
  -d '{ "custom_attributes": { "page": "/pricing" } }'

200Conversa criada

json

{
  "id": 999,
  "inbox_id": 1,
  "contact_last_seen_at": "2026-02-15T14:00:00.000Z",
  "status": "open"
}

GET/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations

Lista as conversas do contato.

Mensagens

POST/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages

Envia uma mensagem na conversa publica.

Body

Nome	Tipo	Obrigatorio	Descricao
`content`	`string`	Sim	Texto da mensagem
`echo_id`	`string`	Nao	ID local para deduplicacao

bash

curl -X POST "https://chat.seudominio.com/public/api/v1/inboxes/INBOX_ID/contacts/CONTACT_ID/conversations/999/messages" \
  -H "Content-Type: application/json" \
  -d '{ "content": "Preciso de ajuda com meu pedido" }'

GET/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages

Lista as mensagens da conversa.

PATCH

/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages/{message_id}

Atualiza uma mensagem (ex: marcar como lida).