Skip to main content
POST
Enviar convite

Autorizações

apikey
string
header
obrigatório

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Parâmetros de caminho

instance
string
obrigatório

O nome de exibição do número no painel do Pilot Status.

Corpo

application/json
groupJid
string
obrigatório

JID do grupo.

Exemplo:

"120363000000000000@g.us"

description
string
obrigatório

Texto da mensagem enviada junto com o convite.

Exemplo:

"Entre no nosso grupo!"

numbers
string[]
obrigatório

Números de telefone (apenas dígitos) para os quais enviar o convite.

Exemplo:

Resposta

Sucesso — corpo de resposta nativo do provedor.

Result of sending the group invite link to the provided numbers.

send
boolean

True when the invite message was dispatched to all numbers.

inviteUrl
string

The invite link that was sent.