Inbound

Your instant inbox (<account code>.oveyon.app): address, mailboxes, state

Read-only: never switches anything on. An account that never switched it on sees the domain it WILL have, with active: false. Receiving works on every plan; sending from it (replies included) only on paid plans (sending). While the instant inbox is not enabled on the platform this route answers 404 not_found, like a route that does not exist. Scope read:inbound.

get/inbound/instant

Request

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

Response

State

domainstring nullable

<code>.oveyon.app — the account short code. null when the account cannot have one (see available).

availableboolean

false = this account cannot have an instant inbox (no short code, or the account is not active).

activeboolean

Whether the account switched it on (POST /v1/inbound/instant). Until then nothing is received there.

urlstring

Changes

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