Pular para o conteúdo
MyClinicAPI Docs
PATCH

/v1/services/{id}

Editar / ativar / desativar serviço

Desativar (active=false) tira o serviço dos selects e dos agentes sem apagar histórico.

Permissão:services: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

  • namestringOpcional

    Entre 2 e 128 caracteres

  • descriptionstring | nullOpcional

    Até 255 caracteres

  • categorystringOpcional

    Entre 2 e 40 caracteres

  • durationintegerOpcional

    Entre 5 e 600

  • pricenumber | nullOpcional

    Valor em reais (BRL). No banco: amount_minor (centavos). · Entre 0 e 10000000

  • activebooleanOpcional

    Padrão: true

  • requiresProfessionalbooleanOpcional

    Padrão: true

  • aiDescriptionstring | nullOpcional

    Até 1000 caracteres

  • rulesstring | nullOpcional

    Até 2000 caracteres

  • professionalsstring[]Opcional

    professional_keys que atendem o serviço. · Até 50 itens · Cada item: até 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/services/<id>", {  method: "PATCH",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "name": "<name>",    "description": "<description>",    "category": "Fisioterapia",    "duration": 5,    "price": 1,    "active": true,    "requiresProfessional": true,    "aiDescription": "<aiDescription>"  }),})​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>",    "key": "sessao-fisioterapia",    "name": "Sessão de Fisioterapia",    "description": "<description>",    "category": "Fisioterapia",    "duration": 1,    "price": 1,    "currency": "<currency>",    "active": true,    "requiresProfessional": true,    "aiDescription": "<aiDescription>",    "rules": "<rules>",    "demand": 1,    "professionals": [      {        "key": "<key>",        "name": "<name>"      }    ],    "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.

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)