Inbound

Switch the instant inbox on, or create a named mailbox on it (<agent>@<code>.oveyon.app)

No DNS on your side: the domain is ours. Without localPart it switches the account inbox on — its domain and the catch-all *@<code>.oveyon.app — and returns the catch-all (201 the first time, 200 after: idempotent). With localPart it creates a named mailbox with its own channels and policies (201), like POST /v1/inbound/routes — the same limits (200 mailboxes per domain, 1000 per account), the same inline webhook (secret shown once), born without security choices. Received mail counts like any inbound mail; above the per-hour limit the MX answers 450 4.2.1 and the sender retries. Sending FROM it is for paid plans only: on the free plan /v1/send and /v1/inbound/{uid}/reply answer 422 managed_domain_requires_paid_plan (SMTP: 550 5.7.1). Forwarding from it follows the forwarding rules of every mailbox (verified destinations only). While the instant inbox is not enabled on the platform this route answers 404 not_found. Scope write:inbound.

post/inbound/instant

Request

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

Request body

localPartstring

The part before the @ (lower-cased). Letters, digits and . _ % + - (no @).

activeboolean

Response

Already on — the catch-all as it is

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.