Pular para o conteúdo
MyClinicAPI Docs
POST

/v1/invitations

Convidar usuário (e-mail + perfil)

Cria o vínculo com status "pendente" e um convite válido por 7 dias. O token nunca é gravado em claro (só o hash) e nunca volta na resposta em produção — as automações enviam o e-mail com o link.

E-mail verificado: quando a verificação de e-mail está ligada no ambiente, contas com e-mail ainda não confirmado recebem 403 email_not_verified.

Permissão:users:manageDispara:user.invited

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

  • emailstring (e-mail)Obrigatório

    Até 160 caracteres

  • namestringOpcional

    Até 128 caracteres

  • rolestringObrigatório

    Valores: admin, profissional, recepcao, financeiro, marketing, suporte, estagiario

  • messagestringOpcional

    Até 500 caracteres

  • professionalKeystringOpcional

    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/invitations", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "email": "contato@exemplo.com",    "role": "admin",    "name": "<name>",    "message": "<message>",    "professionalKey": "<professionalKey>"  }),})​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": {    "invitationId": "<invitationId>",    "user": {      "id": "<id>",      "userId": "<userId>",      "name": "<name>",      "email": "<email>",      "role": "admin",      "roleLabel": "<roleLabel>",      "status": "ativo",      "joinedAt": "2026-09-18T14:00:00.000Z",      "lastAccessAt": "2026-09-18T14:00:00.000Z",      "isCurrent": true,      "professionalKey": "<professionalKey>",      "extraPermissions": [        "<extraPermission>"      ],      "invitationId": "<invitationId>",      "invitationExpiresAt": "2026-09-18T14:00:00.000Z"    },    "expiresAt": "2026-09-18T14:00:00.000Z",    "devInviteToken": "<devInviteToken>"  },  "meta": {    "webhooks": [      {        "event": "appointment.cancelled",        "status": "sent"      }    ]  }}

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

Esta operação tem limite próprio: 20 requisições / 3600 s. Sobre limites

Testar no Swagger(abre em nova aba)