Pular para o conteúdo
PUT

/v1/owner-interview/items/{questionId}

Mudar o estado de uma pergunta (transição validada no servidor)

Pessoa da clínica (onboarding:write) ou a Lívia (X-Agent-Key: knowledge). Versão otimista: envie a versão lida em If-Match: "<n>" (ou version no corpo; 0 para um item sem documento). Versão diferente → 409 version_conflict (atual em details e no ETag); sem versão → 422 version_required.

Transições: pendente → perguntada | pulada; perguntada → aguardando_confirmacao | pulada | expirada; aguardando_confirmacao → aguardando_confirmacao (nova extração) | proposta | perguntada | pulada | expirada; proposta → aprovada | rejeitada; pulada | expirada | rejeitada → perguntada (retomar). aprovada é final. Transição fora da tabela → 409 invalid_transition (permitidas em details).

Aprovar/rejeitar (aprovada, rejeitada) é só de pessoa da clínica com onboarding:approve: token de serviço → 403 agent_cannot_approve.

aguardando_confirmacao exige draftValue (JSON, até 4000 caracteres, criptografado em repouso) e sourceMessageId; proposta exige targetRef (factId/articleId). O rascunho é apagado ao sair de aguardando_confirmacao. Nas perguntas de casos reais (P35–P37, P69, P91), CPF/CNS/nascimento com nome → 422 looks_like_personal_data.

Qualquer uma:onboarding:writeowner-interview: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

Parâmetros de caminho

  • questionIdstringObrigatório

    P01–P93 (ids aposentados continuam legíveis). · Padrão (regex): ^P[0-9]{2}$

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 0

  • statusstringObrigatório

    pendente → perguntada → aguardando_confirmacao → proposta → aprovada (+ pulada, expirada, rejeitada). · Valores: pendente, perguntada, aguardando_confirmacao, proposta, aprovada, pulada, expirada, rejeitada

  • draftValueanyOpcional

    Valor extraído aguardando confirmação (só com aguardando_confirmacao).

  • sourceMessageIdstringOpcional

    Mensagem inbound do dono que sustenta a resposta. · Entre 1 e 64 caracteres

  • targetRefstringOpcional

    factId ou articleId (com proposta). · Entre 1 e 64 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/owner-interview/items/<questionId>", {  method: "PUT",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "X-Agent-Key": "<agent_key>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "status": "pendente",    "version": 0,    "draftValue": "<draftValue>",    "sourceMessageId": "<sourceMessageId>",    "targetRef": "<targetRef>"  }),})​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": {    "questionId": "P01",    "catalogVersion": "<catalogVersion>",    "retired": true,    "phase": 1,    "status": "pendente",    "version": 0,    "target": {      "type": "fact",      "key": "<key>",      "alsoKeys": [        "<alsoKey>"      ],      "fields": [        "<field>"      ]    },    "targetRef": "<targetRef>",    "reviewRequired": true,    "clinicalAssessment": true,    "sourceMessageId": "<sourceMessageId>",    "askedAt": "2026-09-18T14:00:00.000Z",    "answeredAt": "2026-09-18T14:00:00.000Z",    "hasDraft": true,    "draftValue": "<draftValue>",    "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