Pular para o conteúdo
MyClinicAPI Docs
PATCH

/v1/onboarding/session/progress

Atualizar o progresso (passo e percentual) com versão otimista

Pessoa da clínica (onboarding:write) ou a Renata (token de serviço, X-Agent-Key: onboarding).

Versão otimista: envie a versão lida em If-Match: "<n>" (ou version no corpo). Versão diferente da atual → 409 version_conflict com a atual em details (current_version) e no cabeçalho ETag; sem versão → 422 version_required; as duas com valores diferentes → 422 version_mismatch. Sucesso devolve a nova versão (também no ETag).

concluido não é aceito aqui (a conclusão é feita por um humano membro da clínica). Onboarding concluído → 409 onboarding_closed.

Qualquer uma:onboarding:writeonboarding:agent

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

  • If-MatchstringOpcional

    Versão lida (ETag), ex.: "3". · Padrão (regex): ^(W/)?"?[0-9]{1,9}"?$

Corpo da requisição

application/json · obrigatório

  • versionintegerOpcional

    Alternativa ao If-Match. · Mínimo 1

  • stepstringObrigatório

    Passo da entrevista (concluido só pela conclusão, feita por um humano membro da clínica). · Valores: boas_vindas, servicos, horarios, precos, convenios, politica_cancelamento, tom_de_voz, endereco, revisao

  • percentintegerOpcional

    Entre 0 e 100

  • stepStateobjectOpcional

    Estado livre do passo (JSON até 4000 caracteres, sem dado pessoal).

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/progress", {  method: "PATCH",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "X-Agent-Key": "<agent_key>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "step": "boas_vindas",    "version": 1,    "percent": 1,    "stepState": {}  }),})​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>",    "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"  }}

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

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

Testar no Swagger(abre em nova aba)