Pular para o conteúdo
MyClinicAPI Docs
POST

/v1/onboarding/messages

Enviar mensagem para a Renata (um turno por vez, idempotente)

Grava a mensagem do usuário e publica onboarding.message.created (via fila de saída, com event_id estável). A Renata responde pelas rotas próprias; o painel acompanha por GET /v1/onboarding/messages.

Um turno por vez: enquanto a mensagem anterior não tiver a resposta final da Renata → 409 awaiting_reply. Duas mensagens diferentes ao mesmo tempo: só uma vence.

Idempotência: clientMessageId (UUID gerado pelo cliente). O cabeçalho Idempotency-Key é opcional e, se enviado, precisa ser igual a clientMessageId (422 idempotency_key_mismatch). Repetição → 200 com Idempotent-Replayed: true e meta.idempotent = true, sem nova mensagem nem novo evento; o mesmo id com outro texto → 409 idempotency_key_reused.

Limite: 200 mensagens por dia (dia local da clínica) → 429 onboarding_daily_limit. Onboarding concluído → 409 onboarding_closed; não iniciado → 404 onboarding_not_started; teste grátis vencido → 402 trial_expired.

E-mail verificado: quando a verificação de e-mail está ligada no ambiente, contas com e-mail ainda não confirmado recebem 403 email_not_verified.

Permissão:onboarding:writeDispara:onboarding.message.created

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}$

  • Idempotency-KeystringOpcional

    Opcional; igual a clientMessageId.

Corpo da requisição

application/json · obrigatório

  • clientMessageIdstringObrigatório

    UUID gerado pelo cliente para esta mensagem (chave de idempotência).

  • textstringObrigatório

    Entre 1 e 2000 caracteres · Padrão (regex): \S

Exemplo de requisição

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

const res = await fetch("https://myclinc.leadpoint.com.br/v1/onboarding/messages", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "clientMessageId": "8f14e45f-ceea-4e6a-9c3b-1d2f3c4b5a01",    "text": "Atendemos fisioterapia e pilates, de segunda a sexta."  }),})​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": {    "message": {      "id": "<id>",      "sessionId": "<sessionId>",      "role": "user",      "turn": 0,      "part": 1,      "seq": 0,      "text": "<text>",      "clientMessageId": "<clientMessageId>",      "inReplyTo": "<inReplyTo>",      "eventId": "<eventId>",      "delivery": "pendente",      "outcome": "ok",      "final": true,      "authorName": "<authorName>",      "sentAt": "2026-09-18T14:00:00.000Z"    },    "session": {      "id": "<id>",      "status": "ativa",      "step": "boas_vindas",      "percent": 1,      "version": 1,      "turn": 0,      "awaitingReply": {        "messageId": "<messageId>",        "since": "2026-09-18T14:00:00.000Z",        "stale": true      },      "stepState": {},      "startedAt": "2026-09-18T14:00:00.000Z",      "lastMessageAt": "2026-09-18T14:00:00.000Z",      "completedAt": "2026-09-18T14:00:00.000Z",      "createdAt": "2026-09-18T14:00:00.000Z",      "updatedAt": "2026-09-18T14:00:00.000Z"    }  },  "meta": {    "idempotent": true,    "webhooks": [      {        "event": "appointment.cancelled",        "status": "sent"      }    ]  }}
201Created — Sucesso.
JSON
{  "data": {    "message": {      "id": "<id>",      "sessionId": "<sessionId>",      "role": "user",      "turn": 0,      "part": 1,      "seq": 0,      "text": "<text>",      "clientMessageId": "<clientMessageId>",      "inReplyTo": "<inReplyTo>",      "eventId": "<eventId>",      "delivery": "pendente",      "outcome": "ok",      "final": true,      "authorName": "<authorName>",      "sentAt": "2026-09-18T14:00:00.000Z"    },    "session": {      "id": "<id>",      "status": "ativa",      "step": "boas_vindas",      "percent": 1,      "version": 1,      "turn": 0,      "awaitingReply": {        "messageId": "<messageId>",        "since": "2026-09-18T14:00:00.000Z",        "stale": true      },      "stepState": {},      "startedAt": "2026-09-18T14:00:00.000Z",      "lastMessageAt": "2026-09-18T14:00:00.000Z",      "completedAt": "2026-09-18T14:00:00.000Z",      "createdAt": "2026-09-18T14:00:00.000Z",      "updatedAt": "2026-09-18T14:00:00.000Z"    }  },  "meta": {    "idempotent": true,    "webhooks": [      {        "event": "appointment.cancelled",        "status": "sent"      }    ]  }}

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.

402

— Teste grátis encerrado: o painel está em modo somente leitura até a ativação do plano (trial_expired).

403

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

404

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

409

Conflict — Conflito de estado (duplicidade, transição inválida, conflito de agenda).

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

Esta operação tem limite próprio: 60 requisições / 60 s. Sobre limites

Testar no Swagger(abre em nova aba)