Create Mailbox

POST

/mailboxes

• Production
• QA

Connect an existing mailbox over IMAP/SMTP.

Credentials are write-only — they are stored encrypted and never returned by this or any other endpoint. Google/Microsoft mailboxes need the browser OAuth flow and cannot be connected here.

Routes to the same CreateMailboxHandler the in-app “add mailbox” screen uses, so validation and provider detection behave identically.

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

Connect an existing mailbox over IMAP/SMTP.

Google/Microsoft mailboxes are not connectable through this endpoint: OAuth needs a browser redirect that an API call cannot complete on its own. Connect those in the app for now.

object

authentication

string

default: plain

daily_limit

Max sends per day for this mailbox

integer

default: 40 >= 1

display_name

Any of:

string

string

null

null

email

required

The mailbox address, e.g. [email protected]

string

enable_starttls_auto

boolean

default: true

imap_address

required

IMAP host, e.g. imap.acme.com

string

imap_password

required

Write-only. Never returned by any endpoint.

string

imap_port

integer

default: 993

imap_username

required

string

signature_html

Any of:

string

string

null

null

signature_plain

Any of:

string

string

null

null

smtp_address

required

SMTP host, e.g. smtp.acme.com

string

smtp_password

required

Write-only. Never returned by any endpoint.

string

smtp_port

integer

default: 465

smtp_username

required

string

use_html_signature

boolean

Responses

201

Successful Response

object

data

required

A sending mailbox. Credentials are never returned.

object

allows_nurture

Any of:

boolean

boolean

null

null

connection_status

Any of:

string

string

null

null

created_at

Any of:

string

string

null

null

created_by

Any of:

string

string

null

null

daily_limit

Any of:

integer

integer

null

null

display_name

Any of:

string

string

null

null

email

Any of:

string

string

null

null

id

required

integer

is_archived

Any of:

boolean

boolean

null

null

provider

Any of:

string

string

null

null

updated_at

Any of:

string

string

null

null

warmup_enabled

Any of:

boolean

boolean

null

null

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string