---
title: "Update an inbound address"
method: PATCH
path: "/v1/email/inbound-addresses/{inbound_address_id}"
tags: ["email-inbound-addresses"]
---

# Update an inbound address

`PATCH /v1/email/inbound-addresses/{inbound_address_id}`

## Request

- Base URL: `https://us1.platform.bird.com`
- URL: `https://us1.platform.bird.com/v1/email/inbound-addresses/{inbound_address_id}`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bird_session`

Updates the label on an inbound address. The address itself is fixed and cannot be changed.

## Headers

- `Idempotency-Key` string
- `X-Workspace-Id` string
- `X-Organization-Id` string

## Request body

- InboundAddressUpdate: Fields to update on an inbound address.
  - `label` string, nullable: 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.

## Response `200`

Inbound address updated.

- InboundAddress: An email address we create for you, which receives mail on your behalf. Forward a real mailbox (for example, a support inbox) to this address. Every message sent to it becomes a received email you can retrieve.
  - `id` string, required
  - `address` string, email, required: The address to forward your mailbox to. We generate it when the inbound address is created.
  - `label` string, nullable, required: Your own label for this address, typically the source mailbox it maps to. `null` when unset.
  - `created_at` string, date-time, required: When the inbound address was created.
  - `updated_at` string, date-time, required: When the inbound address was last updated.

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error
- `503`: The service is temporarily unavailable. If `Retry-After` is present, wait for that delay before retrying; otherwise, retry with exponential backoff. Reuse the same idempotency key and request when retrying a mutation.

---

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