Skip to main content
PATCH
Update inbox

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
displayName
string | null

Sender display name. Unicode and punctuation are supported. No control characters, line breaks, tabs, or surrounding whitespace. Set null or an empty string to clear.

Maximum string length: 200
webhookUrl
string | null

URL to receive signed webhook events for this inbox. Set null to clear and revert to the account-level webhook. A signing secret is generated the first time a webhook URL is set on this inbox and returned once in the response body.

forwardTo
string | null

Email address that receives a copy of inbound messages, e.g. your own Gmail. Members of your organisation are confirmed at once; any other address is emailed a confirmation link and forwardStatus stays pending until they click it. Re-sending the same pending address re-issues the link. Setting a new address also re-enables forwarding that was paused for bouncing. Set null to stop forwarding.

forwardWhen
enum<string> | null

When to forward. always (default); needs_human only mail the agent should not auto-handle (autoReplyable false); webhook_failed only once webhook delivery has exhausted its retries or there was no webhook or WebSocket to deliver to.

Available options:
always,
needs_human,
webhook_failed,
null

Response

Inbox updated

Inbox updated

id
string

OpenMail inbox ID

podId
string

ID of the pod this inbox belongs to. Inboxes created without an explicit pod land in your account's default pod.

address
string<email>

Full email address

aliases
object[]

Previous receiving addresses and their expiry. Outbound mail uses address.

displayName
string | null

Sender display name

webhookUrl
string | null

URL that receives signed webhook events for this inbox, if set. Overrides the account-level webhook for this inbox only.

webhookSecret
string | null

Signing secret for this inbox's webhook. Only present in the response when the secret is generated or rotated (on create, on first setting a webhook URL, or via the rotate-secret endpoint) — it is never returned afterward.

forwardTo
string | null

Address that receives copies of this inbox's inbound mail, if set.

forwardWhen
enum<string> | null

Which inbound mail is forwarded. Null when forwarding is not set.

Available options:
always,
needs_human,
webhook_failed,
null
forwardStatus
enum<string> | null

pending until the address confirms via the emailed link (members of your organisation are confirmed at once); active once copies are flowing; disabled when forwarding paused itself after the address hard-bounced repeatedly or complained — set forwardTo again to resume. Null when forwarding is not set.

Available options:
pending,
active,
disabled,
null
createdAt
string<date-time>