Skip to main content
PATCH
Update an inbox

Authorizations

Authorization
string
header
required

Organization key (alk_…) created under Settings; acts for the whole organization

Path Parameters

inboxId
string
required

Inbox id

Body

application/json
display_name
string | null
Maximum string length: 80
inbound_mode
enum<string>
Available options:
open,
allowlist
outbound_approval
enum<string>

required: mail an agent token sends, replies or forwards from this inbox is held as awaiting_approval until a member or an organization key approves it. Mail already held stays held when this is set back to off

Available options:
off,
required
metadata
object

Up to 16 string labels, for example your own tenant id

Response

Updated inbox

inbox
object
required