API Reference

Send group invite link

post
https://gate.whapi.cloud/groups/link/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Invite Code

Body Params

Message group invite

string
required

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.

string

Message ID of the message to be quoted

string

Message ID of the message to be edited

string

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

string

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

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:
string

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

string

Mime type of media

boolean

Do not use our encoding

boolean

Do not use the cache in a request

mentions
array of strings

The numbers of the mentioned users

mentions
Responses

Updated about 2 years ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 years ago