Pular para o conteúdo
MyClinicAPI Docs
PATCH

/v1/integrations/{id}/connection

Pausar/retomar e ajustar sincronização (modo, calendários, opções)

Permissão:integrations:manageDispara:integration.settings_updated

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

    integration_id do catálogo (whatsapp, google-calendar, smtp…). · Padrão (regex): ^[a-z0-9-]{2,64}$

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

  • pausedbooleanOpcional
  • syncModestringOpcional

    Valores: Tempo real (recomendado), A cada 15 minutos, A cada hora, Manual

  • calendarsobject[]Opcional

    Até 50 itens

  • idstringObrigatório
    calendars[].id

    Até 128 caracteres

  • enabledbooleanObrigatório
    calendars[].enabled
  • syncSettingsobject[]Opcional

    Até 30 itens

  • idstringObrigatório
    syncSettings[].id

    Até 64 caracteres

  • valuebooleanObrigatório
    syncSettings[].value

Exemplo de requisição

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

const res = await fetch("https://myclinc.leadpoint.com.br/v1/integrations/<id>/connection", {  method: "PATCH",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "paused": true,    "syncMode": "Tempo real (recomendado)",    "calendars": [      {        "id": "<id>",        "enabled": true      }    ],    "syncSettings": [      {        "id": "<id>",        "value": true      }    ]  }),})​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>",    "name": "<name>",    "summary": "<summary>",    "description": "<description>",    "category": "<category>",    "availability": "disponivel",    "auth": "oauth",    "provider": "<provider>",    "benefits": [      "<benefit>"    ],    "status": "ativa",    "connection": {      "status": "conectando",      "account": "<account>",      "connectedAt": "2026-09-18T14:00:00.000Z",      "connectedBy": "<connectedBy>",      "lastActivityAt": "2026-09-18T14:00:00.000Z",      "lastHealthcheckAt": "2026-09-18T14:00:00.000Z",      "lastErrorCode": "<lastErrorCode>"    },    "scopes": [      {        "id": "<id>",        "label": "<label>",        "description": "<description>",        "required": true,        "sensitive": true,        "default": true      }    ],    "credentialRef": "<credentialRef>",    "eventsSynced": 1,    "config": {      "syncMode": "<syncMode>",      "grantedScopes": [        "<grantedScope>"      ],      "calendars": [        {          "id": "<id>",          "name": "<name>",          "description": "<description>",          "enabled": true,          "isDefault": true        }      ],      "syncSettings": [        {          "id": "<id>",          "label": "<label>",          "value": true        }      ]    },    "webhooks": [      {        "id": "<id>",        "event": "<event>",        "endpoint": "<endpoint>",        "active": true,        "lastDelivery": "2026-09-18T14:00:00.000Z"      }    ]  },  "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).

404

Not Found — Recurso não encontrado na clínica ativa.

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)