Pular para o conteúdo
MyClinicAPI Docs
POST

/v1/conversations

Iniciar conversa com um contato

Informe patientId ou leadId (recomendado) ou contactName + phone/email. Usado também pela automação de atendimento ao receber o primeiro contato.

Agent Preview (somente token de serviço): externalRef = prefixo reservado de prévia + UUIDv4 em minúsculas e channel = outros, sem patientId, leadId, contactName, phone nem email (422). A sessão pertence ao agente que a criou; repetir a mesma sessão devolve 200 com Idempotent-Replayed: true; sessão de outro agente → 404.

Permissão:conversations:write

Autenticação

Envie o token de acesso do usuário no cabeçalho Authorization e, se ele tiver mais de uma clínica, o X-Clinic-Id. Integrações servidor a servidor usam o token de serviço com X-Clinic-Id e X-Agent-Key. Como autenticar

Authorization: Bearer <TOKEN>X-Clinic-Id: <clinic_id>

Parâmetros

Cabeçalhos

  • X-Clinic-IdstringOpcional

    Clínica ativa. Obrigatório só para quem tem acesso a mais de uma clínica (ou token de serviço). Validado contra o vínculo do usuário. · Padrão (regex): ^[A-Za-z0-9._-]{1,64}$

Corpo da requisição

application/json · obrigatório

  • channelstringObrigatório

    Valores: whatsapp, email, sms, instagram, outros

  • patientIdstringOpcional

    Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

  • leadIdstringOpcional

    Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

  • contactNamestringOpcional

    Entre 2 e 128 caracteres

  • phonestringOpcional

    Até 32 caracteres

  • emailstring (e-mail)Opcional

    Até 160 caracteres

  • externalRefstringOpcional

    Id da conversa no provedor (somente token de serviço). · Até 255 caracteres

Exemplo de requisição

Gerado do contrato. Troque os marcadores entre < > pelos seus valores.

const res = await fetch("https://myclinc.leadpoint.com.br/v1/conversations", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "X-Agent-Key": "<agent_key>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "channel": "whatsapp",    "patientId": "<patientId>",    "leadId": "<leadId>",    "contactName": "<contactName>",    "phone": "<phone>",    "email": "contato@exemplo.com",    "externalRef": "<externalRef>"  }),})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

200OK — Sucesso.
JSON
{  "data": {    "id": "<id>",    "name": "<name>",    "channel": "whatsapp",    "preview": "<preview>",    "lastMessageAt": "2026-09-18T14:00:00.000Z",    "unread": 1,    "mine": true,    "assignedTo": {      "id": "<id>",      "name": "<name>"    },    "archived": true,    "activeAgent": {      "key": "<key>",      "name": "<name>",      "image": "<image>"    },    "patientId": "<patientId>",    "leadId": "<leadId>",    "tags": [      "<tag>"    ]  }}
201Created — Sucesso.
JSON
{  "data": {    "id": "<id>",    "name": "<name>",    "channel": "whatsapp",    "preview": "<preview>",    "lastMessageAt": "2026-09-18T14:00:00.000Z",    "unread": 1,    "mine": true,    "assignedTo": {      "id": "<id>",      "name": "<name>"    },    "archived": true,    "activeAgent": {      "key": "<key>",      "name": "<name>",      "image": "<image>"    },    "patientId": "<patientId>",    "leadId": "<leadId>",    "tags": [      "<tag>"    ]  }}

Exemplo gerado do esquema da resposta; valores entre < > são ilustrativos.

Códigos de erro

Corpo no formato padrão { error: { code, message, requestId } }. Veja todos os códigos.

400

Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).

401

Unauthorized — Token ausente, inválido ou expirado.

403

Forbidden — Autenticado, mas sem permissão (perfil ou clínica).

404

Not Found — Recurso não encontrado na clínica ativa.

422

Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).

429

Too Many Requests — Limite de requisições excedido (veja Retry-After).

500

Internal Server Error — Erro interno (sem detalhes expostos).

503

Service Unavailable — Banco de dados indisponível ou não configurado.

Limites

Limite padrão: 120 requisições a cada 60 segundos por token. Sobre limites

Testar no Swagger(abre em nova aba)