Ver newsletter pelo convite

GET /newsletter-invites/{key}

Os dados da newsletter de um link de convite, antes de seguir.

Autenticação

[
  {
    "token": []
  }
]

{
  "token": {
    "name": "token",
    "type": "apiKey",
    "in": "header"
  }
}

Parâmetros

[
  {
    "name": "key",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string"
    },
    "description": "A chave do convite (o fim do link `whatsapp.com/channel/...`) ou o link inteiro."
  }
]

Respostas

{
  "200": {
    "description": "A newsletter.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Newsletter"
        },
        "example": {
          "id": "120363123456789012@newsletter",
          "name": "Loja Ofertas",
          "description": "Promoções toda semana.",
          "picture_url": "https://pps.whatsapp.net/v/t61/canal.jpg",
          "picture_preview_url": "https://pps.whatsapp.net/v/t61/canal_preview.jpg",
          "subscriber_count": 1520,
          "verified": false,
          "invite_code": "0029VaAbCdEfGhIjKlMn",
          "reaction_mode": "basic",
          "state": "active",
          "created_at": "2026-05-01T12:00:00.000Z",
          "role": "guest",
          "muted": false
        }
      }
    }
  },
  "401": {
    "description": "Token inválido ou ausente.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "unauthorized",
          "message": "Token inválido."
        }
      }
    }
  },
  "403": {
    "$ref": "#/components/responses/NotAdminWhatsApp"
  },
  "404": {
    "description": "Convite inválido.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "not_found",
          "message": "Convite inválido."
        }
      }
    }
  },
  "429": {
    "$ref": "#/components/responses/RateLimited"
  },
  "500": {
    "$ref": "#/components/responses/InternalError"
  },
  "501": {
    "$ref": "#/components/responses/CloudUnsupported"
  },
  "503": {
    "description": "`disconnected`: a inbox está desconectada do WhatsApp. `unavailable`: o WhatsApp não respondeu agora (conexão caindo ou sem resposta); tente de novo.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "unavailable",
          "message": "O WhatsApp não respondeu agora; tente de novo."
        }
      }
    }
  }
}

Estado: Disponível

Compatibilidade de canais

Canal	Compatível	Observação
WhatsApp (Web)	Sim
WhatsApp (API oficial)	Não	A API oficial não tem newsletters.
Instagram	Não
Messenger	Não
Telegram	Não

Eventos que esta rota gera

Nenhum. Esta rota não gera evento no webhook (nem em GET /events): o resultado vem só na resposta.

Antes e depois (uazapi → Orkesio)

Na uazapi: POST /newsletter/link.

key no caminho (antes no corpo).
Sem o envelope response: responde a newsletter no formato novo.

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id"
  ],
  "description": "Newsletter do WhatsApp.",
  "properties": {
    "id": {
      "type": "string",
      "description": "Id da newsletter (`<id>@newsletter`)."
    },
    "name": {
      "type": "string",
      "description": "Nome."
    },
    "description": {
      "type": "string",
      "description": "Descrição."
    },
    "picture_url": {
      "type": "string",
      "description": "Foto completa, quando conhecida."
    },
    "picture_preview_url": {
      "type": "string",
      "description": "Miniatura da foto, quando conhecida (use nas listas)."
    },
    "subscriber_count": {
      "type": "integer",
      "description": "Número de seguidores."
    },
    "verified": {
      "type": "boolean",
      "description": "Newsletter verificada."
    },
    "invite_code": {
      "type": "string",
      "description": "Código do convite (o fim do link `whatsapp.com/channel/...`)."
    },
    "reaction_mode": {
      "type": "string",
      "enum": [
        "all",
        "basic",
        "none",
        "blocklist"
      ],
      "description": "Que reações os seguidores podem usar: `all` qualquer emoji, `basic` só os emojis padrão do WhatsApp, `none` nenhuma, `blocklist` a lista de bloqueio definida no app."
    },
    "state": {
      "type": "string",
      "enum": [
        "active",
        "suspended",
        "geosuspended"
      ],
      "description": "Estado da newsletter: `active` no ar, `suspended` suspensa pelo WhatsApp, `geosuspended` suspensa em alguns países."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Criação. ISO 8601 em UTC com milissegundos."
    },
    "role": {
      "type": "string",
      "enum": [
        "owner",
        "admin",
        "subscriber",
        "guest"
      ],
      "description": "O papel da inbox na newsletter: `owner` dona, `admin` administradora, `subscriber` segue, `guest` não segue."
    },
    "muted": {
      "type": "boolean",
      "description": "A inbox silenciou a newsletter."
    }
  }
}

#/components/schemas/OrkesioError

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP."
    },
    "message": {
      "type": "string",
      "description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`."
    },
    "field": {
      "type": "string",
      "description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)."
    }
  },
  "required": [
    "error",
    "message"
  ],
  "additionalProperties": true,
  "description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)."
}

#/components/responses/NotAdminWhatsApp

{
  "description": "`not_admin`: o WhatsApp recusou por falta de permissão (em geral, só o dono ou um administrador pode; na leitura, o catálogo ou o canal não está aberto para esta conta).",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "not_admin",
        "message": "O WhatsApp recusou por falta de permissão (em geral, só o dono ou um administrador pode)."
      }
    }
  }
}

#/components/responses/RateLimited

{
  "description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.",
  "headers": {
    "Retry-After": {
      "description": "Segundos até poder chamar de novo.",
      "schema": {
        "type": "integer",
        "minimum": 1
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "rate_limited",
        "message": "Muitas requisições."
      }
    }
  }
}

#/components/responses/InternalError

{
  "description": "`internal_error`: falha inesperada na api (no banco, por exemplo); tente de novo.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "internal_error",
        "message": "Falha inesperada."
      }
    }
  }
}

#/components/responses/CloudUnsupported

{
  "description": "`unsupported_for_channel`: o canal da inbox não atende esta rota (rota só do WhatsApp Web numa inbox oficial, ou rota da API oficial numa inbox do WhatsApp Web). O canal está em `Inbox.channel`.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "unsupported_for_channel",
        "message": "Esta rota não está disponível no canal da inbox."
      }
    }
  }
}

Guias relacionados

Visão geral · O que funciona em cada canal · O que muda da uazapi