POST

https://{server-url}

/
group
/
sendInvite
/
{instance}

Authorizations

apikey
string
headerrequired

Your authorization key header

Path Parameters

instance
string
required

ID of the instance to connect

Body

application/json
groupJid
string
required

Group remote JID

numbers
string[]
required

Numbers to receive the invitation

description
string

Description to send with the invitation

Response

200 - application/json
send
boolean

Indicates if the invite was sent successfully.

inviteUrl
string

The URL for the WhatsApp group invite.