> ## Documentation Index > Fetch the complete documentation index at: https://docs.superlead.app/llms.txt > Use this file to discover all available pages before exploring further. # Mover Lead de Etapa > Move o lead para uma etapa do funil. Operação **idempotente**: repetir com a etapa atual retorna `200` com `changed: false`, sem log duplicado — seguro para retries. - Obtenha o `stage_id` em `GET /v1/funnel/stages`. Os ids são **estáveis**: sobrevivem a renomeações da etapa no painel. - A transição grava o histórico no painel com origem `API`, usando o `reason` como observação. Pular etapas registra as intermediárias automaticamente. - As etapas são escopadas pela sua chave: `stage_id` de outra empresa retorna `404 stage_not_found`. ## OpenAPI ````yaml /openapi.json put /v1/leads/{id}/stage openapi: 3.1.0 info: title: Superlead API version: 1.0.0 description: > API oficial do Superlead para envio de mensagens WhatsApp aos **seus leads**. ## Autenticação Toda chamada exige `Authorization: Bearer sk_...` (crie a chave no painel Superlead em Integrações → API). A chave é escopada à sua empresa. ## Início rápido ```bash curl -X POST https://api.superlead.app/v1/whatsapp/messages \ -H "Authorization: Bearer sk_SUACHAVE" \ -H "Idempotency-Key: pedido-8734" \ -H "Content-Type: application/json" \ -d '{"to":"+5511999999999","type":"text","text":{"body":"Olá!"}}' ``` No n8n: nó **HTTP Request**, método POST, header Authorization como acima. ## Endereçamento O campo `to` aceita **telefone E.164** (`+5511999999999`) ou **BSUID** (`BR.13491208655302741918` — o `fromUserId` entregue nos webhooks quando o contato usa username do WhatsApp; usernames nunca endereçam). O destinatário precisa ser um lead existente da sua empresa — o envio nunca cria leads. Para outreach, crie antes com `POST /v1/leads`. Use `external_id` para reconciliar com o seu sistema. ## Janela de 24h (regra da Meta) Mensagens de formato livre (text, image, ...) só são entregues se o lead falou com você nas últimas 24 horas. Fora da janela, use `type: "template"` com um template aprovado (liste-os em `GET /v1/whatsapp/templates`). Fora da janela a Meta pode rejeitar o envio na hora (`outside_24h_window`) OU aceitá-lo (201, status `accepted`) e falhá-lo de forma assíncrona segundos depois — a mensagem passa ao status `failed`. Confirme em `GET /v1/whatsapp/messages/{id}` ou pelo webhook `whatsapp.message.updated`. ## Idempotência Envie o header `Idempotency-Key` (recomendado). Retries com a mesma chave e mesmo body retornam a resposta original sem reenviar. Validade: 24h. ## Rate limit 60 requisições/min por chave (headers `X-RateLimit-*`; `429` inclui `Retry-After`). ## Status da mensagem A resposta traz o status inicial. Acompanhe `sent → delivered → read` (ou `failed`) pelos webhooks do Superlead (evento `whatsapp.message.updated`) ou por `GET /v1/whatsapp/messages/{id}`. O evento de status identifica a mensagem pelo `wamid` retornado na resposta do envio. ## Erros Envelope estável `{ "error": { "code", "message", "request_id" } }`. Trate códigos desconhecidos pelo HTTP status (novos códigos são mudança aditiva). | HTTP | code | Meaning | |---|---|---| | 400 | `invalid_request` | The request body is invalid. Check the details field and the API reference. | | 401 | `invalid_api_key` | Missing or invalid API key. Send it as 'Authorization: Bearer sk_...'. | | 404 | `lead_not_found` | No lead matches this recipient in your company. The API only messages existing leads. | | 404 | `message_not_found` | No message with this id exists in your company. | | 404 | `stage_not_found` | No funnel stage with this id exists in your company. List valid stages with GET /v1/funnel/stages. | | 409 | `idempotency_conflict` | This Idempotency-Key was already used with a different request body, or the original request is still in progress. | | 409 | `lead_already_exists` | A lead with this phone number already exists in your company. You can message it directly via POST /v1/whatsapp/messages. | | 422 | `funnel_not_configured` | Your company has no funnel stages configured. Set up the funnel in the Superlead panel first. | | 422 | `no_active_connection` | Your company has no active WhatsApp connection. Connect a number in the Superlead panel first. | | 422 | `connection_expired` | Your WhatsApp connection is no longer authorized. Reconnect it in the Superlead panel. | | 422 | `channel_capability_unsupported` | Your company's WhatsApp connection type does not support this operation. | | 422 | `outside_24h_window` | Free-form messages require the lead to have messaged you within the last 24 hours. Send an approved template instead. | | 422 | `template_not_found` | Template not found. Check the exact name and language with GET /v1/whatsapp/templates. | | 422 | `template_params_invalid` | Template parameters do not match the approved template. Check count, format and language. | | 422 | `recipient_unavailable` | The recipient cannot receive this message on WhatsApp right now. | | 422 | `media_unsupported` | WhatsApp could not fetch or process the media. Check that the link is public and direct, the format is supported and the file is within the size limit for its type. | | 422 | `message_blocked` | Meta blocked this message (spam or ecosystem limits). Reduce volume to this recipient and review quality. | | 429 | `rate_limit_exceeded` | Rate limit for this API key exceeded. Retry after the time in the Retry-After header. | | 429 | `channel_rate_limit` | WhatsApp is throttling your number. Slow down and retry later. | | 502 | `channel_error` | The messaging provider returned an unexpected error. Our team was notified; retry later. | | 500 | `internal_error` | Internal error. Our team was notified; retry later. | ## Versionamento Caminho `/v1/`. Mudanças incompatíveis só em `/v2/`. Campos novos opcionais podem aparecer a qualquer momento — ignore campos desconhecidos. servers: - url: https://api.superlead.app description: Produção security: [] paths: /v1/leads/{id}/stage: put: summary: Mover Lead de Etapa description: >- Move o lead para uma etapa do funil. Operação **idempotente**: repetir com a etapa atual retorna `200` com `changed: false`, sem log duplicado — seguro para retries. - Obtenha o `stage_id` em `GET /v1/funnel/stages`. Os ids são **estáveis**: sobrevivem a renomeações da etapa no painel. - A transição grava o histórico no painel com origem `API`, usando o `reason` como observação. Pular etapas registra as intermediárias automaticamente. - As etapas são escopadas pela sua chave: `stage_id` de outra empresa retorna `404 stage_not_found`. operationId: moveLeadStage parameters: - name: id in: path required: true schema: type: string description: >- Id do lead (`lead_...`), retornado por `POST /v1/leads`, `GET /v1/leads?phone=...` ou `GET /v1/leads/{id}`. example: lead_0b5f8a3e-1a2b-3c4d-5e6f-7a8b9c0d1e2f requestBody: required: true content: application/json: schema: type: object required: - stage_id additionalProperties: false properties: stage_id: type: string pattern: ^stage_\d+$ description: >- Id da etapa de destino (`stage_N`), obtido em `GET /v1/funnel/stages`. example: stage_7 reason: type: string minLength: 1 maxLength: 500 description: >- Motivo da transição, exibido como observação no histórico do lead no painel (até 500 caracteres). example: respondeu no site example: stage_id: stage_7 reason: respondeu no site responses: '200': description: >- Resultado do movimento. `changed: false` indica no-op (o lead já estava na etapa). content: application/json: schema: type: object properties: lead_id: type: string description: Id do lead movido. example: lead_0b5f8a3e-1a2b-3c4d-5e6f-7a8b9c0d1e2f previous_stage: type: - object - 'null' description: >- Etapa em que o lead estava. `null` se o lead não tinha etapa. properties: id: type: string example: stage_3 name: type: string example: 1º Contato current_stage: type: object description: Etapa atual após a operação. properties: id: type: string example: stage_7 name: type: string example: Qualificado changed: type: boolean description: >- `true` se o lead mudou de etapa; `false` se já estava na etapa de destino (no-op, sem log). moved_at: type: string format: date-time description: Data da transição (ISO 8601, UTC). example: '2026-07-08T12:00:00.000Z' example: lead_id: lead_0b5f8a3e-1a2b-3c4d-5e6f-7a8b9c0d1e2f previous_stage: id: stage_3 name: 1º Contato current_stage: id: stage_7 name: Qualificado changed: true moved_at: '2026-07-08T12:00:00.000Z' '400': description: >- `invalid_request` — o body ou os parâmetros da requisição são inválidos. O campo `details` aponta cada campo com problema. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: invalid_request message: The request body is invalid. request_id: req_01J9X7K2M3N4P5Q6R7S8T9V0W1 details: - path: to message: Required '401': description: >- `invalid_api_key` — chave de API ausente, malformada ou revogada. Envie `Authorization: Bearer sk_...`. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: invalid_api_key message: >- Missing or invalid API key. Send it as 'Authorization: Bearer sk_...'. request_id: req_01J9X7K2M3N4P5Q6R7S8T9V0W1 '404': description: >- `lead_not_found` — nenhum lead com este id. `stage_not_found` — nenhuma etapa com este id na sua empresa (liste as válidas em `GET /v1/funnel/stages`). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: stage_not_found message: >- No funnel stage with this id exists in your company. List valid stages with GET /v1/funnel/stages. request_id: req_01J9X7K2M3N4P5Q6R7S8T9V0W1 security: - apiKey: [] components: schemas: Error: type: object properties: error: type: object properties: code: type: string description: >- Código estável do erro (ex.: `lead_not_found`). Novos códigos podem surgir a qualquer momento — trate códigos desconhecidos pelo HTTP status. example: lead_not_found message: type: string description: >- Descrição legível do erro, em inglês. O texto pode mudar — não faça parsing dele; use `code`. request_id: type: string description: >- Id único desta requisição. Inclua ao reportar um problema ao suporte. example: req_01J9X7K2M3N4P5Q6R7S8T9V0W1 upstream_code: type: number description: >- Código numérico original da Meta, presente quando o erro veio do WhatsApp (ex.: `131047` para fora da janela de 24h). example: 131047 details: type: array description: >- Erros de validação campo a campo. Presente em respostas `400 invalid_request`. items: type: object properties: path: type: string description: 'Caminho do campo inválido no body (ex.: `text.body`).' message: type: string description: O que está errado com o campo. securitySchemes: apiKey: type: http scheme: bearer description: >- Chave de API da sua empresa (`sk_...`). Crie no painel Superlead em **Integrações → API** e envie em toda chamada como `Authorization: Bearer sk_...`. Veja [Autenticação](/guias/autenticacao). ````