Pular para o conteúdo
MyClinicAPI Docs
PATCH

/v1/appointments/{id}

Editar sala, modalidade, tags, observações e registro clínico da sessão

notes (observações operacionais) exige só schedule:write. reason/nextSteps (registro clínico) exigem clinical:write. Status muda só pelas ações dedicadas (confirm, cancel, reschedule…).

Permissão:schedule:write

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

    Id do recurso. · 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}$

Corpo da requisição

application/json · obrigatório

  • roomstring | nullOpcional

    Até 64 caracteres

  • modalitystringOpcional

    Valores: presencial, online

  • tagsstring[]Opcional

    Até 10 itens · Cada item: até 40 caracteres

  • notesstring | nullOpcional

    Até 5000 caracteres

  • reasonstring | nullOpcional

    Até 2000 caracteres

  • nextStepsobject[]Opcional

    Até 20 itens

  • labelstringObrigatório
    nextSteps[].label

    Até 200 caracteres

  • donebooleanObrigatório
    nextSteps[].done

Exemplo de requisição

Gerado do contrato. Troque os marcadores entre < > pelos seus valores.

const res = await fetch("https://myclinc.leadpoint.com.br/v1/appointments/<id>", {  method: "PATCH",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "room": "<room>",    "modality": "presencial",    "tags": [      "<tag>"    ],    "notes": "<notes>",    "reason": "<reason>",    "nextSteps": [      {        "label": "<label>",        "done": true      }    ]  }),})​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>",    "date": "2026-09-18",    "start": "14:00",    "end": "14:00",    "durationMin": 1,    "startsAt": "2026-09-18T14:00:00.000Z",    "kind": "consulta",    "patient": "<patient>",    "patientId": "<patientId>",    "leadId": "<leadId>",    "professional": {      "key": "<key>",      "name": "<name>"    },    "service": {      "key": "<key>",      "name": "<name>"    },    "status": "agendado",    "statusLabel": "<statusLabel>",    "outcome": "ATTENDED",    "origin": "agente",    "modality": "presencial",    "room": "<room>",    "agent": {      "agentKey": "<agentKey>",      "name": "<name>",      "image": "<image>",      "state": "agendado",      "at": "2026-09-18T14:00:00.000Z",      "note": "<note>"    },    "notes": "<notes>",    "reason": "<reason>",    "nextSteps": [      {        "label": "<label>",        "done": true      }    ],    "clinicalRedacted": true,    "tags": [      "<tag>"    ]  }}

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.

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)