Pular para o conteúdo
MyClinicAPI Docs
POST

/v1/clinics

Cadastrar clínica (tenant) — somente platform_admin

Cria em status DRAFT (PRD §8: criar clínica inicia onboarding; não ativa atendimento automatizado).

Autenticação

Envie o token de acesso do usuário no cabeçalho Authorization. Integrações servidor a servidor usam o token de serviço com X-Clinic-Id e X-Agent-Key. Como autenticar

Authorization: Bearer <TOKEN>

Parâmetros

Corpo da requisição

application/json · obrigatório

  • idstringOpcional

    clinic_id desejado (slug). Gerado a partir do nome se omitido. · Padrão (regex): ^[a-z0-9-]{3,40}$

  • namestringObrigatório

    Entre 2 e 128 caracteres

  • legalNamestringOpcional

    Até 160 caracteres

  • timezonestringOpcional

    Até 64 caracteres

  • citystringOpcional

    Até 80 caracteres

  • statestringOpcional

    Até 2 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/clinics", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "name": "<name>",    "id": "<id>",    "legalName": "<legalName>",    "timezone": "<timezone>",    "city": "<city>",    "state": "<s"  }),})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

201Created — Sucesso.
JSON
{  "data": {    "id": "mowa",    "name": "Clínica Mowa",    "tagline": "<tagline>",    "legalName": "<legalName>",    "cnpj": "<cnpj>",    "email": "<email>",    "phone": "<phone>",    "site": "<site>",    "timezone": "America/Sao_Paulo",    "locale": "pt-BR",    "dateFormat": "<dateFormat>",    "timeFormat": "<timeFormat>",    "currency": "<currency>",    "address": {      "street": "<street>",      "district": "<district>",      "zip": "14400-000",      "city": "<city>",      "state": "SP",      "country": "<country>"    },    "city": "<city>",    "status": "DRAFT",    "logoUrl": "<logoUrl>",    "logoLocked": true,    "monthlyRevenueGoal": 1  }}

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

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)