Inbound

Create a mailbox (and attach channels in one call)

Creates local@domain (or the catch-all *@domain) on a domain of your account, optionally attaching a new webhook and/or existing channels of the same domain. The mailbox is born WITHOUT security choices (agentSafetyMode null, retroScan off): nothing created by API holds mail by default. Limits: 200 mailboxes per domain, 1000 per account (422). Scope write:inbound.

post/inbound/routes

Request

  • Base URL: https://api.oveyon.com/v1
  • URL: https://api.oveyon.com/v1/inbound/routes
  • Auth: HTTP bearer

Request body

domainstring required

A domain of your account (name, not id).

matchType'exact' | 'catchall' required
localPartstring

Required for exact (the part before the @). Lower-cased.

activeboolean

Response

Created — the inline webhook secret is shown once

idinteger
domainstring
addressstring

local@domain, or *@domain for a catch-all.

matchType'exact' | 'catchall'
localPartstring nullable
activeboolean
inboundEnabledboolean

Whether inbound is switched on for the DOMAIN (portal). A mailbox on a domain with inbound off does not receive yet.

agentSafetyModestring nullable

null = the mailbox delivers everything with the verdict (default for API-created mailboxes); dangerous = holds dangerous messages (set in the portal).

retroScanboolean
spamFilterboolean

The mailbox spam filter is on (opt-in; false on every new mailbox). See spamFilter on received messages.

createdAtstring date-time
updatedAtstring date-time nullable
createdBystring nullable

api:<key prefix>, portal:<user>, wizard:<user>, admin:<operator>; null = before this was recorded.

channelCountinteger

List only: active channels attached.

urlstring

Changes

No recorded changes to this operation across all 1 revision of this API.