Inboxes

Update an inbox

paused stops both receiving (mail is dropped) and sending.

patch/v1/inboxes/{inboxId}

Request

  • Base URL: https://api.volanea.com
  • URL: https://api.volanea.com/v1/inboxes/{inboxId}
  • Auth: HTTP bearer

Path parameters

inboxIdstring required

Inbox id.

Request body

displayNamestring nullable
status'active' | 'paused'
metadataobject nullable
securityMode'off' | 'tag' | 'hold'

Response

The updated inbox.

inboxIdstring required
addressstring email required
domainstring required
kind'shared' | 'custom' required

shared: on the platform's shared inbox domain, no DNS needed. custom: on a domain of your own.

displayNamestring nullable

Used as the From name on mail sent from this inbox.

status'active' | 'paused' | 'deleted' required
securityMode'off' | 'tag' | 'hold'

Scan received mail for attempts to manipulate an AI agent. tag: deliver now, label security-review if flagged. hold: withhold from the agent (no email.received, hidden from reads) until the scan clears it or a project key releases it.

clientIdstring nullable

Your idempotency key from creation, if you passed one.

metadataobject nullable
createdAtstring date-time required
updatedAtstring date-time required

Changes

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