API referenceGroups
Update group settings
Partial update for subject, description, announce mode, and locked mode.
Requires send, a connected session, and enough WhatsApp rights to change the setting.
Errors: validation_error, not_found, forbidden, not_implemented.
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 action.
Example
"01HZ0SESSION0000000000000"gid*string
Group JID.
Example
"120363041234567890@g.us"Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
announce?boolean
When true, only admins can post.
Example
truedescription?string
New description.
Example
"Sprint planning and on-call coordination."locked?boolean
When true, only admins can edit group info.
Example
falsesubject?string
New subject.
Example
"Engineering Team (renamed)"Response Body
application/json
curl -X PATCH "https://example.com/api/v1/sessions/01HZ0SESSION0000000000000/groups/120363041234567890@g.us" \ -H "Content-Type: application/json" \ -d '{}'Empty
{ "error": { "code": "not_found", "details": { "property1": null, "property2": null }, "message": "session not found" }}