PATCH

/v1/clinic

Atualizar dados da clínica

Status do tenant não é alterável aqui (somente plataforma).

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

1Authorization: Bearer <TOKEN>2X-Clinic-Id: <clinic_id>

Parâmetros

Cabeçalhos

Cabeçalhos
Parâmetro	Tipo	Obrigatório	Descrição
`X-Clinic-Id`	string	Não	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}$`

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

Campos do corpo da requisição
Parâmetro	Tipo	Obrigatório	Descrição
`name`	string	Não	Entre 2 e 128 caracteres
`tagline`	string \| null	Não	Até 200 caracteres
`legalName`	string \| null	Não	Até 160 caracteres
`cnpj`	string \| null	Não	Padrão (regex): `^\d{2}\.?\d{3}\.?\d{3}/?\d{4}-?\d{2}$`
`email`	string (e-mail) \| null	Não	Até 160 caracteres
`phone`	string \| null	Não	Até 32 caracteres
`site`	string (URL) \| null	Não	Até 255 caracteres
`timezone`	string	Não	Até 64 caracteres
`locale`	string	Não	Valores: `pt-BR`, `en-US`, `es-ES`
`dateFormat`	string	Não	Valores: `DD/MM/AAAA`, `MM/DD/AAAA`, `AAAA-MM-DD`
`timeFormat`	string	Não	Valores: `24`, `12`
`monthlyRevenueGoal`	number \| null	Não	Meta de receita mensal (reais). null remove a meta. · Entre 0 e 100000000 · Múltiplo de 0.01
`currency`	string	Não	Valores: `BRL`, `USD`, `EUR`
`address`	object	Não	—
`street` address.street	string \| null	Não	Até 160 caracteres
`district` address.district	string \| null	Não	Até 80 caracteres
`zip` address.zip	string \| null	Não	Até 10 caracteres
`city` address.city	string \| null	Não	Até 80 caracteres
`state` address.state	string \| null	Não	Até 2 caracteres
`country` address.country	string \| null	Não	Até 2 caracteres

namestringOpcional
Entre 2 e 128 caracteres
taglinestring | nullOpcional
Até 200 caracteres
legalNamestring | nullOpcional
Até 160 caracteres
cnpjstring | nullOpcional
Padrão (regex): ^\d{2}\.?\d{3}\.?\d{3}/?\d{4}-?\d{2}$
emailstring (e-mail) | nullOpcional
Até 160 caracteres
phonestring | nullOpcional
Até 32 caracteres
sitestring (URL) | nullOpcional
Até 255 caracteres
timezonestringOpcional
Até 64 caracteres
localestringOpcional
Valores: pt-BR, en-US, es-ES
dateFormatstringOpcional
Valores: DD/MM/AAAA, MM/DD/AAAA, AAAA-MM-DD
timeFormatstringOpcional
Valores: 24, 12
monthlyRevenueGoalnumber | nullOpcional
Meta de receita mensal (reais). null remove a meta. · Entre 0 e 100000000 · Múltiplo de 0.01
currencystringOpcional
Valores: BRL, USD, EUR
addressobjectOpcional
streetstring | nullOpcional
address.street
Até 160 caracteres
districtstring | nullOpcional
address.district
Até 80 caracteres
zipstring | nullOpcional
address.zip
Até 10 caracteres
citystring | nullOpcional
address.city
Até 80 caracteres
statestring | nullOpcional
address.state
Até 2 caracteres
countrystring | nullOpcional
address.country
Até 2 caracteres

Exemplo de requisição

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

1const res = await fetch("https://myclinc.leadpoint.com.br/v1/clinic", {2  method: "PATCH",3  headers: {4    Authorization: "Bearer <TOKEN>",5    "X-Clinic-Id": "<clinic_id>",6    "Content-Type": "application/json",7  },8  body: JSON.stringify({9    "name": "<name>",10    "tagline": "<tagline>",11    "legalName": "<legalName>",12    "cnpj": "<cnpj>",13    "email": "contato@exemplo.com",14    "phone": "<phone>",15    "site": "https://exemplo.com",16    "timezone": "America/Sao_Paulo"17  }),18})1920if (!res.ok) {21  const { error } = await res.json()22  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)23}24const { data } = await res.json()

Resposta

200OK — Sucesso.

JSON

1{2  "data": {3    "id": "mowa",4    "name": "Clínica Mowa",5    "tagline": "<tagline>",6    "legalName": "<legalName>",7    "cnpj": "<cnpj>",8    "email": "<email>",9    "phone": "<phone>",10    "site": "<site>",11    "timezone": "America/Sao_Paulo",12    "locale": "pt-BR",13    "dateFormat": "<dateFormat>",14    "timeFormat": "<timeFormat>",15    "currency": "<currency>",16    "address": {17      "street": "<street>",18      "district": "<district>",19      "zip": "14400-000",20      "city": "<city>",21      "state": "SP",22      "country": "<country>"23    },24    "city": "<city>",25    "status": "DRAFT",26    "logoUrl": "<logoUrl>",27    "logoLocked": true,28    "monthlyRevenueGoal": 129  }30}

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).

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