# `bird whatsapp groups update`

## Usage

```bash
bird whatsapp groups update <group-id> [flags]
```

## Description

Update a WhatsApp group

Change a group's subject, description or picture. Fields you omit are left alone. WhatsApp applies each field separately, so one can be refused while the others take effect. Only an active group can be changed.

Build the request from flags, a JSON WhatsAppGroupUpdate body via --body-file ("-" reads
stdin), or both — a flag overrides the matching body field. Run --example to
print a ready-to-edit body, or --dry-run to print the resolved request without
sending it.

## Examples

```bash
# print the body shape (no credentials needed)
bird whatsapp groups update --example

# the body it prints:
```

```json
{
  "description": "Discuss the latest timepieces and share reviews.",
  "profile_picture_url": "https://media.example.com/whatsapp/groups/square.jpg",
  "subject": "Watch Enthusiasts"
}
```

## Options

#### Request

| Name                | Description                                                  |
| ------------------- | ------------------------------------------------------------ |
| `--body-file`       | Read the JSON request body from this file; "-" reads stdin   |
| `--example`         | Print a complete example request body, then exit             |
| `--dry-run`         | Print the resolved request without sending it, then exit     |
| `--idempotency-key` | Deduplication key; a retry with the same key won't act twice |

#### Options

| Name                    | Description                                                                                                                                                                                                                                                                                                                                                                                                                        |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--subject`             | A new name for the group. Participants see the change in the group's chat.                                                                                                                                                                                                                                                                                                                                                         |
| `--description`         | A new description for the group. Send null to clear it; an empty string is a 422 rather than a second way to clear.                                                                                                                                                                                                                                                                                                                |
| `--profile-picture-url` | A new picture for the group, naming a file in your workspace's media library. WhatsApp takes a square JPEG of at least 192 by 192 pixels and up to 5 MB; anything else returns a 422. Sending null clears the picture Bird stores, and an empty string is a 422 rather than a second way to clear it; WhatsApp has no operation for removing a group's photo, so the one participants see stays until another picture replaces it. |
| `--response-schema`     | Print the fields this command returns, then exit                                                                                                                                                                                                                                                                                                                                                                                   |

## Related

| Name                                                                        | Description             |
| --------------------------------------------------------------------------- | ----------------------- |
| [`bird whatsapp groups create`](/docs/cli/reference/whatsapp-groups-create) | Create a WhatsApp group |
| [`bird whatsapp groups delete`](/docs/cli/reference/whatsapp-groups-delete) | Delete a WhatsApp group |
| [`bird whatsapp groups get`](/docs/cli/reference/whatsapp-groups-get)       | Get a WhatsApp group    |
| [`bird whatsapp groups list`](/docs/cli/reference/whatsapp-groups-list)     | List WhatsApp groups    |

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)