Skip to main content
POST
Send invite

Authorizations

apikey
string
header
required

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

Path Parameters

instance
string
required

The number's display name in the Pilot Status dashboard.

Body

application/json
groupJid
string
required

Group JID.

Example:

"120363000000000000@g.us"

description
string
required

Message text sent alongside the invite.

Example:

"Entre no nosso grupo!"

numbers
string[]
required

Phone numbers (digits only) to send the invite to.

Example:

Response

Success — provider-native response body.

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.