WhatsApp Gateway
API referenceGroups

Join a group by invite

POST
/api/v1/sessions/{session}/groups:join

Join the group from an invite code or link and return groupJid.

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 will join the group. Must be connected.

Example"01HZ0SESSION0000000000000"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

invite?string

Invite code or full WhatsApp chat link.

Example"FaKeInViTeCoDe123"

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/sessions/01HZ0SESSION0000000000000/groups:join" \  -H "Content-Type: application/json" \  -d '{}'
{  "groupJid": "string"}
{  "error": {    "code": "not_found",    "details": {      "property1": null,      "property2": null    },    "message": "session not found"  }}