# `bird email ip-pools update`

## Usage

```bash
bird email ip-pools update <ip-pool-id> [flags]
```

## Description

Update an IP pool

Rename an IP pool or make it the organization default. Setting is_default true moves the default to this pool; the default is moved, never cleared, so setting is_default false on the current default is rejected. Pass ipp_shared to make the shared pool the default.

Build the request from flags, a JSON IPPoolUpdate 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 email ip-pools update --example

# the body it prints:
```

```json
{
  "name": "Marketing"
}
```

## Options

#### Pool

| Name           | Description                                                                                     |
| -------------- | ----------------------------------------------------------------------------------------------- |
| `--name`       | The pool's name.                                                                                |
| `--is-default` | Make this pool the organization's default. The default moves to this pool; it is never cleared. |

#### 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                                      |
| ------------------- | ------------------------------------------------ |
| `--response-schema` | Print the fields this command returns, then exit |

## Related

| Name                                                                      | Description       |
| ------------------------------------------------------------------------- | ----------------- |
| [`bird email ip-pools create`](/docs/cli/reference/email-ip-pools-create) | Create an IP pool |
| [`bird email ip-pools delete`](/docs/cli/reference/email-ip-pools-delete) | Delete an IP pool |
| [`bird email ip-pools get`](/docs/cli/reference/email-ip-pools-get)       | Get an IP pool    |
| [`bird email ip-pools list`](/docs/cli/reference/email-ip-pools-list)     | List IP pools     |