---
title: "Change a WhatsApp group description"
method: POST
path: "/api/v1/tools/update_group_description"
---

# Change a WhatsApp group description

`POST /api/v1/tools/update_group_description`

## Request

- Base URL: `https://whatsync.app`
- URL: `https://whatsync.app/api/v1/tools/update_group_description`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Replace the description of a QR group. An empty string clears it. Requires admin rights if the group is locked.

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `idempotencyKey` string, required: Unique key for this intended action. Reuse exactly on retries; use a new key only for a new action.
  - `jid` string, required
  - `description` string, required

## Response `200`

JSON result. Every response includes X-Request-Id.

- object

## Other responses

- `400`: API error
- `401`: API error
- `403`: API error
- `404`: API error
- `409`: API error
- `413`: API error
- `415`: API error
- `422`: API error
- `429`: API error
- `503`: API error

---

[API](https://skmtc.dev/whatsync/apis/whatsync-api.md) · [All operations](https://skmtc.dev/whatsync/apis/whatsync-api/llms.txt) · [OpenAPI document](https://skmtc.dev/whatsync/apis/whatsync-api/revisions/6fa5498b63b7?raw)