Pular para o conteúdo
MyClinicAPI Docs
POST

/v1/onboarding/facts/{key}/approve

Aprovar a proposta (ou editar e aprovar)

Aprova a proposta aberta factId da chave. Com value, a pessoa edita antes de aprovar (o valor é validado pelo esquema da chave). O fato aprovado entra no contexto dos agentes a partir de effectiveFrom (padrão: agora) e o aprovado anterior sai nesse instante. Emite clinic.profile.updated (sem o valor).

Versão: If-Match: "<versão da chave>" (ou version). Diferente da atual → 409 version_conflict (details current_version; ETag com a atual); ausente → 422 version_required. Fato que não é proposta aberta → 409 invalid_state_transition; de outra chave ou inexistente → 404. Valor com dado de pessoa física → 422 looks_like_personal_data.

Não grava em serviços nem no cadastro da clínica (D4).

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:clinic.profile.updated

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

  • keystringObrigatório

    Chave do fato: servicos, horarios, precos, convenios, politica_cancelamento, tom_de_voz, endereco. Desconhecida → 422 unknown_fact_key. · Entre 1 e 64 caracteres

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 da chave lida em GET /v1/onboarding/facts, ex.: "3". · Padrão (regex): ^(W/)?"?[0-9]{1,9}"?$

Corpo da requisição

application/json · obrigatório

  • factIdstringObrigatório

    Proposta aberta (proposal.id em GET /v1/onboarding/facts). · Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

  • valueanyOpcional

    Valor no formato da chave (esquemas: FatoServicos, FatoHorarios, FatoPrecos, FatoConvenios, FatoPoliticaCancelamento, FatoTomDeVoz, FatoEndereco).

  • notestringOpcional

    Até 1000 caracteres

  • effectiveFromstring (data-hora)Opcional

    Início da vigência (padrão: agora; data passada vale como agora).

  • versionintegerOpcional

    Alternativa ao If-Match. · Mínimo 0

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/facts/<key>/approve", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "X-Agent-Key": "<agent_key>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "factId": "<factId>",    "value": "<value>",    "note": "<note>",    "effectiveFrom": "2026-01-15T14:00:00.000Z",    "version": 0  }),})​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": {    "key": "servicos",    "label": "<label>",    "required": true,    "version": 0,    "current": {      "id": "<id>",      "key": "servicos",      "status": "proposto",      "value": "<value>",      "origin": "agente",      "sourceMessageId": "<sourceMessageId>",      "evidence": "<evidence>",      "confidence": 1,      "proposedBy": "<proposedBy>",      "proposedAt": "2026-09-18T14:00:00.000Z",      "decidedBy": "<decidedBy>",      "decidedAt": "2026-09-18T14:00:00.000Z",      "note": "<note>",      "edited": true,      "effectiveFrom": "2026-09-18T14:00:00.000Z",      "effectiveUntil": "2026-09-18T14:00:00.000Z",      "version": 1    },    "upcoming": {      "id": "<id>",      "key": "servicos",      "status": "proposto",      "value": "<value>",      "origin": "agente",      "sourceMessageId": "<sourceMessageId>",      "evidence": "<evidence>",      "confidence": 1,      "proposedBy": "<proposedBy>",      "proposedAt": "2026-09-18T14:00:00.000Z",      "decidedBy": "<decidedBy>",      "decidedAt": "2026-09-18T14:00:00.000Z",      "note": "<note>",      "edited": true,      "effectiveFrom": "2026-09-18T14:00:00.000Z",      "effectiveUntil": "2026-09-18T14:00:00.000Z",      "version": 1    },    "proposal": {      "id": "<id>",      "key": "servicos",      "status": "proposto",      "value": "<value>",      "origin": "agente",      "sourceMessageId": "<sourceMessageId>",      "evidence": "<evidence>",      "confidence": 1,      "proposedBy": "<proposedBy>",      "proposedAt": "2026-09-18T14:00:00.000Z",      "decidedBy": "<decidedBy>",      "decidedAt": "2026-09-18T14:00:00.000Z",      "note": "<note>",      "edited": true,      "effectiveFrom": "2026-09-18T14:00:00.000Z",      "effectiveUntil": "2026-09-18T14:00:00.000Z",      "version": 1    },    "history": [      {        "id": "<id>",        "key": "servicos",        "status": "proposto",        "value": "<value>",        "origin": "agente",        "sourceMessageId": "<sourceMessageId>",        "evidence": "<evidence>",        "confidence": 1,        "proposedBy": "<proposedBy>",        "proposedAt": "2026-09-18T14:00:00.000Z",        "decidedBy": "<decidedBy>",        "decidedAt": "2026-09-18T14:00:00.000Z",        "note": "<note>",        "edited": true,        "effectiveFrom": "2026-09-18T14:00:00.000Z",        "effectiveUntil": "2026-09-18T14:00:00.000Z",        "version": 1      }    ]  },  "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

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

Testar no Swagger(abre em nova aba)