EVevolution-foundation
Group Controller

Send Group Invite

Changed on

Send group invite

post/group/sendInvite/{instance}

Request

  • Base URL
    https://evolution-example
  • URL
    https://evolution-example/group/sendInvite/{instance}
  • Auth
    API key in header apikey

Path parameters

instancestring required

Name of the instance

Request body

groupJidstring required

Group remote JID

descriptionstring required

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"
}

Changes

  • v26cc9e69eaf4cRevision changes
    • breaking

      the request property became required

  • v2c153448703e5Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • info

      api operation id sendGroupInvite was added

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      api tag Group Controller added

    • info

      api tag Group removed

    • info

      added the new optional request property