Inbound

Switch a mailbox (and its spam filter) on/off and attach channels (additive)

patch/inbound/routes/{id}

Request

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

Path parameters

idinteger required

Request body

activeboolean
spamFilterboolean

The spam filter of this mailbox (rspamd at our receiving edge): true = every message arriving here is scanned and gets spamFilter (score, suggested action, rules); false = not scanned (the default of every mailbox — opt-in). It only annotates: act on the score with an inbound policy (spam_filter.score). Turning it ON while the platform does not offer the filter yet answers 409 spam_filter_unavailable and changes nothing.

Response

Current state

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.