Skip to main content
POST
Get invite link

Authorizations

apikey
string
header
required

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

Body

application/json
groupJid
string
required

Group JID (<id>@g.us).

Example:

"120363012345678901@g.us"

reset
boolean

When true, revokes the current link and generates a new one.

Example:

false

Response

Success — provider-native response body.

Envelope returned for Get invite link. data is the invite URL string returned by whatsmeow GetGroupInviteLink.

message
string

Always "success" on HTTP 200.

data
string

The group invite link (https://chat.whatsapp.com/).