v1

latestOpenAPI 3.0.3raw.githubusercontent.com2024-06-11720209.3 KB
Group Controller

Send Group Invite

Send group invite

post/group/sendInvite/{instance}

Path parameters

instancestring required

ID of the instance to connect

Request body

groupJidstring required

Group remote JID

descriptionstring

Description to send with the invitation

numbersstring[] required

Numbers to receive the invitation

Response

Ok

sendboolean

Indicates if the invite was sent successfully.

inviteUrlstring

The URL for the WhatsApp group invite.

Example response

{
  "send": true,
  "inviteUrl": "https://chat.whatsapp.com/DgQvyfXzY01B6rGrpZpYze"
}