Skip to content

Bulk Import Mailboxes

POST
/mailboxes/bulk-import

Connect many mailboxes you already own, from CSV. Buys nothing.

202 means ACCEPTED, not imported: the work runs in the background and the response carries no per-row outcome. Poll GET /mailboxes to see what landed, and expect rows to appear gradually rather than all at once.

Credentials in the CSV are write-only - stored encrypted and never returned by this or any other endpoint.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Import mailboxes from CSV. Credentials in the CSV are write-only.

object
csv_content
required

Raw CSV. Credential columns are stored encrypted and never returned.

string

Responses

202

Successful Response

object
data
required

An open envelope for one provider/deliverability result.

Open on purpose. These payloads are provider state and advisory reads whose contents grow with the product, and a dropped field reads as “nothing to report” rather than “we did not tell you”. Every value passes through scrub_vendor_names on the way in.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string