Skip to main content
POST
Create an inbox

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

The inbox's own part of the address: 1 to 31 lowercase letters, digits and hyphens, starting with a letter or digit. It cannot be changed later. postmaster, abuse, hostmaster, webmaster, noreply, no-reply, bounces and mailer-daemon are reserved.

Pattern: ^[a-z0-9][a-z0-9-]{0,30}$
display_name
string
required
Minimum string length: 1
description
string

Response

The inbox.

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>