> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sequenzy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Inbox Address

> Use a branded inbox address on your own domain

Choose a branded inbox address such as `support@inbound.acme.com` on one of your verified sending domains, or clear it to use only the default address. The address uses the domain's inbound host, usually `inbound.{domain}` (older domains may use `inbound.` on their root domain), so your existing mailboxes on `acme.com` are not affected. `customAddress.address` in the response is the exact address.

The branded address starts receiving once the domain's inbound MX record is verified. Until then `customAddress.status` is `pending` and `address` stays the default `inbox+{companyId}@inbound.sequenzy.com`, which keeps working either way. The MX record is shown in **Settings → Inbox**, and [Verify Sending Domain](../websites/verify) rechecks it.

Changing or clearing an active branded address stops the old address immediately.

Requires the `companies:manage` scope, like other workspace settings. Reading the address with Get Inbox Address only needs `conversations:read`.

## Request

<ParamField body="localPart" type="string | null" required>
  Name before the @, such as `support`. 1 to 64 letters, numbers, dots, dashes
  or underscores, starting and ending with a letter or number. Stored in
  lowercase. Some names such as `postmaster` and `abuse` are reserved. Send
  `null` together with `domain: null` to clear the branded address.
</ParamField>

<ParamField body="domain" type="string | null" required>
  One of your verified sending domains, such as `acme.com`. Send `null` together
  with `localPart: null` to clear.
</ParamField>

```bash theme={null}
curl -X PUT "https://api.sequenzy.com/api/v1/conversations/inbox-address" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"localPart": "support", "domain": "acme.com"}'
```

Go back to the default address:

```bash theme={null}
curl -X PUT "https://api.sequenzy.com/api/v1/conversations/inbox-address" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"localPart": null, "domain": null}'
```

The response has the same shape as [Get Inbox Address](./inbox-address).

## Responses

<ResponseExample>
  ```json 200 theme={null}
  {
    "success": true,
    "inbox": {
      "enabled": true,
      "address": "inbox+comp_abc123@inbound.sequenzy.com",
      "defaultAddress": "inbox+comp_abc123@inbound.sequenzy.com",
      "addresses": ["inbox+comp_abc123@inbound.sequenzy.com"],
      "customAddress": {
        "localPart": "support",
        "domain": "acme.com",
        "address": "support@inbound.acme.com",
        "status": "pending"
      },
      "attachmentsAvailable": true,
      "retentionDays": 90
    }
  }
  ```

  ```json 400 theme={null}
  {
    "error": "Use 1-64 letters, numbers, dots, dashes or underscores, starting and ending with a letter or number.",
    "code": "invalid_local_part"
  }
  ```

  ```json 404 theme={null}
  {
    "error": "Choose one of your verified sending domains.",
    "code": "domain_not_found"
  }
  ```

  ```json 409 theme={null}
  {
    "error": "support@inbound.acme.com is already used by another workspace.",
    "code": "address_taken"
  }
  ```
</ResponseExample>