Pular para o conteúdo
MyClinicAPI Docs
POST

/v1/onboarding/messages/{id}/retry

Tentar de novo: reenviar a mensagem à Renata (mesmo evento)

Reenvia o mesmo evento (event_id igual) da mensagem que aguarda resposta — a automação deduplica por ele. Liberado quando a entrega falhou (delivery falhou/desativada) ou quando o turno está "demorando" (awaitingReply.stale, 90 s). Mensagem já respondida, da Renata ou ainda dentro do prazo → 409 invalid_state_transition. Onboarding concluído → 409 onboarding_closed. Onboarding desligado no ambiente (ONBOARDING_RENATA_ENABLED=false e clínica fora de ONBOARDING_RENATA_CLINICS) → 409 onboarding_disabled.

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

Parâmetros de caminho

  • idstringObrigatório

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

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

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/<id>/retry", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",  },})​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": {    "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: 30 requisições / 60 s. Sobre limites

Testar no Swagger(abre em nova aba)