Pular para o conteúdo
MyClinicAPI Docs
POST

/v1/leads/{id}/stage

Mover etapa do funil

"Fora do perfil" (NOT_A_FIT) exige reason (motivos sugeridos em /leads/metadata). HUMAN_HANDOFF pode indicar o responsável humano. O payload do webhook traz route_to (agente que deve assumir).

Permissão:leads:writeDispara:lead.stage_changed

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

    Id do recurso. · Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

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

  • stagestringObrigatório

    Valores: NEW, DISCOVERY, QUALIFIED, READY_TO_SCHEDULE, SCHEDULED, COMPLETED, NURTURE, NOT_A_FIT, HUMAN_HANDOFF

  • reasonstringOpcional

    Até 255 caracteres

  • ownerMembershipIdstringOpcional

    Responsável humano (HUMAN_HANDOFF). · Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

Exemplo de requisição

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

const res = await fetch("https://myclinc.leadpoint.com.br/v1/leads/<id>/stage", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "stage": "NEW",    "reason": "<reason>",    "ownerMembershipId": "<ownerMembershipId>"  }),})​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>",    "age": 1,    "sex": "<sex>",    "phone": "<phone>",    "email": "<email>",    "city": "<city>",    "source": "META_ADS",    "sourceLabel": "<sourceLabel>",    "channel": "WhatsApp",    "service": {      "key": "<key>",      "name": "<name>"    },    "stage": "NEW",    "stageLabel": "<stageLabel>",    "score": 1,    "qualified": true,    "ready": true,    "appointment": "agendado",    "appointmentAt": "2026-09-18T14:00:00.000Z",    "appointmentId": "<appointmentId>",    "professional": {      "key": "<key>",      "name": "<name>"    },    "lastInteractionAt": "2026-09-18T14:00:00.000Z",    "lastInteractionMin": 1,    "nextAction": {      "label": "<label>",      "at": "2026-09-18T14:00:00.000Z",      "actionable": true    },    "owner": {      "type": "human",      "id": "<id>",      "name": "<name>"    }  },  "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)