Send group invite link

post

https://gate.whapi.cloud/groups/link/{InviteCode}

Sends the group invitation link identified by InviteCode to the recipient specified in to. It does not join the connected account to the group.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

InviteCode

string

required

^[A-Za-z0-9]{14,22}$

Invite Code

Body Params

Message group invite

Media file to send. You can use preuploaded file or upload file on the fly. Use preupload files if you want to send same file to multiple chats and so as not to disturb the order of messages.

string

required

^[\d-]{9,31}(@[\w\.]{1,})?$

Use the phone number or Chat ID of the contact/group/channel to which you want to send the message. Use Get groups to get the group ID.

quoted

string

^[A-Za-z0-9._]{4,30}-[A-Za-z0-9._]{4,30}(-[A-Za-z0-9._]{2,30})?(-[A-Za-z0-9._]{2,30})?$

Message ID of the message to be quoted

edit

string

^[A-Za-z0-9._]{4,30}-[A-Za-z0-9._]{4,30}(-[A-Za-z0-9._]{2,30})?(-[A-Za-z0-9._]{2,30})?$

Message ID of the message to be edited

title

string

Title of the group. If not set, the group title will be used

body

string

Invite message with link. Example: "Follow this link to join my group on WhatsApp". Use %URL% to insert the invite link.

preview_type

string

enum

Defaults to group_picture

Type of the group preview. Use 'group_picture' to set a group picture as large preview, 'thumbnail' to set a custom small jpeg image from 'preview' param as preview, 'media' to set a custom large image from 'media' param as large preview, 'style1' to set a isometric style for group invite link preview stub, 'style2' to set a flat style for group invite link preview stub, 'style3' to set a WA style for group invite link preview stub, or 'none' to not set a preview. If not set, the default is group_picture.

Allowed:

preview

string

Base64 encoded image for small version group invite link preview (preview_type=thumbnail). In JPEG format

media

File to upload

mime_type

string

Mime type of media

no_encode

boolean

Do not use our encoding

no_cache

boolean

Do not use the cache in a request

mentions

array of strings

The numbers of the mentioned users

mentions

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200Created

400Wrong request parameters

401Need channel authorization for this action

402Trial version limit exceeded

404Specified group not found

429Too many requests

500Internal Error