# `bird whatsapp keyword-rules update`

## Usage

```bash
bird whatsapp keyword-rules update <id> [flags]
```

## Description

Update a WhatsApp keyword rule

Change one of your own keyword rules: its reply or its extra keywords. Bird's own rules cannot be changed; create your own instead with `bird whatsapp keyword-rules create`. Omitting `keywords` leaves the set alone, while sending an empty list clears your additions back to Bird's.

Build the request from flags, a JSON WhatsAppKeywordRuleUpdate 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 keyword-rules update --example

# the body it prints:
```

```json
{
  "keywords": ["no more texts"],
  "reply": "You're off the list. ACME Courier won't message you again."
}
```

## 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                                                                                                                                                               |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--keywords <value>…` | Replaces the extra keywords this rule matches, on top of the ones Bird ships. Send an empty array to keep Bird's keywords only. Omit to leave the current ones unchanged. |
| `--reply`             | Replaces the message sent back when a keyword matches. Set it to null to send nothing. Omit to leave it unchanged.                                                        |
| `--response-schema`   | Print the fields this command returns, then exit                                                                                                                          |

## Related

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

## 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)