WhatsApp Gateway
API referenceGroups

Get the group invite link

GET
/api/v1/sessions/{session}/groups/{gid}/invite

Live lookup of group's current invite URL.

Requires read, a connected session, and admin rights in the group. Returns {"invite": "https://chat.whatsapp.com/..."}.

Errors: not_found, forbidden, not_implemented.

Authorization

AuthorizationBearer <token>

Send Authorization: Bearer <token>. The token can be a login JWT from the frontend or an api-key for a script. JWT access comes from the person's organization role. Api-key access comes from the permissions saved on the key.

In: header

Path Parameters

session*string

WhatsApp session id that owns the group. Must be connected for this live lookup.

Example"01HZ0SESSION0000000000000"
gid*string

Group JID.

Example"120363041234567890@g.us"

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/sessions/01HZ0SESSION0000000000000/groups/120363041234567890@g.us/invite"
{  "invite": "string"}
{  "error": {    "code": "not_found",    "details": {      "property1": null,      "property2": null    },    "message": "session not found"  }}