Pular para o conteúdo
MyClinicAPI Docs
POST

/v1/professionals

Cadastrar profissional

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

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

  • keystringOpcional

    Padrão (regex): ^[a-z0-9-]{2,64}$

  • namestringObrigatório

    Entre 2 e 128 caracteres

  • specialtystring | nullOpcional

    Até 128 caracteres

  • statusstringOpcional

    Valores: ativo, inativo

  • roomstring | nullOpcional

    Até 64 caracteres

  • calendarRefstring | nullOpcional

    Id do calendário (Google). Write-only: volta mascarado. · Até 255 caracteres

  • timezonestring | nullOpcional

    Até 64 caracteres

  • servicesstring[]Opcional

    Até 100 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/professionals", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "name": "<name>",    "key": "<key>",    "specialty": "<specialty>",    "status": "ativo",    "room": "<room>",    "calendarRef": "<calendarRef>",    "timezone": "<timezone>",    "services": [      "<service>"    ]  }),})​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": "<id>",    "key": "renata",    "name": "<name>",    "specialty": "<specialty>",    "status": "ativo",    "room": "<room>",    "calendarRef": "<calendarRef>",    "hasCalendar": true,    "timezone": "<timezone>",    "userId": "<userId>",    "services": [      {        "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).

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)