WhatsApp Gateway
API referenceGroups

Leave a group

Removes the session's **own** account from the group. **Capability:** requires `send`. **Precondition (live action):** the session must be **connected**. If it is not the gateway responds **501 `not_implemented`**. **Success:** **204 No Content**. After leaving, this session can no longer act on the group; reading still works only on whatever stored data remains. **Errors:** - **404 `not_found`** — the session or group does not exist (or is not yours). - **501 `not_implemented`** — the session is not connected.

POST
/api/v1/sessions/{session}/groups/{gid}:leave

Authorization

AuthorizationBearer <token>

Send Authorization: Bearer <token>. The router accepts two kinds of token and tries each in turn: a frontend-minted login JWT (verified against the frontend JWKS; the person's org + role are read from it), or an api-key for a script/service (carrying a fixed set of gateway permissions). The bearerFormat: JWT label describes the person-login case.

In: header

Path Parameters

session*string

The WhatsApp session id whose account will leave the group; must be connected for this live action.

gid*string

The group's JID, ending in @g.us. Percent-encode the @ as %40 in the URL path.

Response Body

application/json

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