Skip to main content
PATCH
Change an inbox

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

id
string
required

The inbox's ID.

Body

application/json
display_name
string

Cannot be empty.

description
string | null
is_active
boolean
is_default
boolean

true makes it the default. false does nothing.

Response

The inbox, as it now is.

id
string
name
string

The inbox's own part of the address. It cannot be changed.

display_name
string

What people see it called.

description
string | null
is_default
boolean

Mail to your organization's bare address arrives here, and replies to email sent with Send an email come back here.

is_active
boolean

false once retired: mail sent to its address is turned away, and it cannot be sent from.

is_restricted
boolean

Whether only the people and roles on its access list may read it.

address
string<email>

The full address to publish, or to forward your own mail to.

created_at
string<date-time>
updated_at
string<date-time>