Pular para o conteúdo
MyClinicAPI Docs
POST

/v1/onboarding/session/complete

Concluir o onboarding

Exige fato aprovado em vigor nas chaves obrigatórias (servicos, horarios, endereco, tom_de_voz); faltando → 422 onboarding_incomplete com uma linha por chave em details.

Conclui a sessão (concluida, passo concluido), leva a clínica de ONBOARDING para READY_FOR_TEST (uma clínica ACTIVE continua ACTIVE), desliga a Renata na clínica e emite onboarding.completed uma vez. Repetição → 200 com meta.idempotent = true (completa o que tiver faltado, sem novo evento).

Sessão não iniciada → 404 onboarding_not_started; teste grátis vencido → 402.

Quem: só uma pessoa com vínculo na clínica. Token de serviço (agentes) e equipe da plataforma recebem 403 approval_requires_clinic_member.

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:approveDispara:onboarding.completed

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

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/session/complete", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "X-Agent-Key": "<agent_key>",  },})​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": {    "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"    },    "clinicStatus": "<clinicStatus>",    "approvedKeys": [      "servicos"    ]  },  "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.

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)