Get the group invite link
Returns the group's current invite link (a `https://chat.whatsapp.com/<code>` URL anyone can use to join), in the shape `{ "invite": "https://chat.whatsapp.com/..." }`. **Capability:** requires `read`. **Precondition (live lookup):** unlike most read endpoints this is a **live** WhatsApp query, so the session must be **connected**; if it is not the gateway responds **501 `not_implemented`**. The session's account must also be a group admin to fetch the link. **Errors:** - **404 `not_found`** — the session or group does not exist (or is not yours). - **403 `forbidden`** — the session's account is not an admin of this group. - **501 `not_implemented`** — the session is not connected.
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
The WhatsApp session id that owns the group; must be connected for this live lookup.
The group's JID, ending in @g.us. Percent-encode the @ as %40 in the URL path.
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" }}Update group settings PATCH
Changes the group's settings — **subject**, **description**, whether only admins can post (**announce**), and whether only admins can edit group info (**locked**). **Partial update:** send only the fields you want to change; omitted fields are left untouched. Each field maps to a separate WhatsApp operation, applied in order. **Capability:** requires `send`. **Precondition (live action):** the session must be **connected** and (for most settings) its account must be a group **admin**. If the session is not connected the gateway responds **501 `not_implemented`**. **Success:** **204 No Content**. **Errors:** - **400 `validation_error`** — malformed body. - **404 `not_found`** — the session or group does not exist (or is not yours). - **403 `forbidden`** — the session's account lacks the rights to change this setting. - **501 `not_implemented`** — the session is not connected.
Reset the group invite link DELETE
Cancels the current invite link and generates a new one, then returns it in the shape `{ "invite": "https://chat.whatsapp.com/..." }`. **Side effect:** any previously shared link **stops working** immediately — share the returned link going forward. **Capability:** requires `send`. **Precondition (live action):** the session must be **connected** and its account must be a group **admin**. If the session is not connected the gateway responds **501 `not_implemented`**. **Errors:** - **404 `not_found`** — the session or group does not exist (or is not yours). - **403 `forbidden`** — the session's account is not an admin of this group. - **501 `not_implemented`** — the session is not connected.