Create inbox

Inbox local part (default: random)

Sender display name shown in the From header

Domain for the inbox address. Defaults to your account domain (e.g. openmail.sh). Pass a verified custom domain you own to create the inbox on it (e.g. agent-mail.example.com). The domain must already be added and verified for your account; the account default never switches automatically.

URL to receive signed webhook events for this inbox (e.g. inbound mail). Overrides the account-level webhook for this inbox only. A signing secret is generated and returned once in the response body.

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 nothing is forwarded until they click it (forwardStatus is pending meanwhile). Spam and bulk mail are never forwarded. Replies go to the original sender.

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.

Pod to create the inbox in. Accepts the pod ID or your own clientId. Omit to place the inbox in your account's default pod.

OpenMail inbox ID

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

Full email address

Sender display name

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

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.

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

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

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.