Conversations
Update Inbox Address
Use a branded inbox address on your own domain
PUT
Update Inbox Address
Choose a branded inbox address such as
Go back to the default address:
The response has the same shape as Get Inbox Address.
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 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
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.string | null
required
One of your verified sending domains, such as
acme.com. Send null together
with localPart: null to clear.