# `bird email inbound-addresses update`

## Usage

```bash
bird email inbound-addresses update <inbound-address-id> [flags]
```

## Description

Update an inbound address

Update the label on an inbound address.

Build the request from flags, a JSON InboundAddressUpdate 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 inbound-addresses update --example

# the body it prints:
```

```json
{
  "label": "Sales mailbox"
}
```

## Options

#### Address

| Name      | Description                                                                                                                            |
| --------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `--label` | Your own label for this address, typically the source mailbox it maps to. Send null to clear it; omit the field to leave it unchanged. |

#### 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 inbound-addresses create`](/docs/cli/reference/email-inbound-addresses-create) | Create an inbound address |
| [`bird email inbound-addresses delete`](/docs/cli/reference/email-inbound-addresses-delete) | Delete an inbound address |
| [`bird email inbound-addresses get`](/docs/cli/reference/email-inbound-addresses-get)       | Get an inbound address    |
| [`bird email inbound-addresses list`](/docs/cli/reference/email-inbound-addresses-list)     | List inbound addresses    |