Skip to main content
POST
Send Group Invite

Authorizations

apikey
string
header
required

Your authorization key header

Path Parameters

instance
string
required

Name of the instance

Body

application/json
groupJid
string
required

Group remote JID

description
string
required

Description to send with the invitation

numbers
string[]
required

Numbers to receive the invitation

Response

200 - application/json

Ok

send
boolean

Indicates if the invite was sent successfully.

inviteUrl
string

The URL for the WhatsApp group invite.