Organization API: Org Mail: Mail

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled List org tenants

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

List org tenants

GET /api/v1/orgs/{org_slug}/mail/tenants

Parameters

Name	In	Type	Required	Description
`org_slug`	path	string	yes
`customer_id`	query	integer or null	no
`kind`	query	string or null	no
`q`	query	string or null	no
`limit`	query	integer	no	Default: `100`.

Responses

Section titled Get summary

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Get summary

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled List aliases

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

List aliases

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/aliases

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Create alias

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Create alias

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/aliases

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`domain_id`	integer	yes
`local_part`	string	yes
`targets`	array of string	yes

Responses

Section titled Delete alias

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Delete alias

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/aliases/{account_id}

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Set category

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Set category

PATCH /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/category

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`default_category`	string	yes

Responses

Section titled List credentials

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

List credentials

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/credentials

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Create credential

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Create credential

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/credentials

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`domain_id`	integer	yes
`label`	string	no

Responses

Section titled Delete credential

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Delete credential

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/credentials/{account_id}

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Credential enabled

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Credential enabled

PATCH /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/credentials/{account_id}/enabled

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`enabled`	boolean	yes

Responses

Section titled Rotate credential

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Rotate credential

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/credentials/{account_id}/rotate

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled List domains

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

List domains

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Add domain

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Add domain

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`domain`	string	yes
`primary`	boolean	no

Responses

Section titled Remove domain

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Remove domain

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains/{domain_id}

Parameters

Name	In	Type	Required
`domain_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Set DMARC

Section titled Set DMARC

PATCH /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains/{domain_id}/dmarc

Parameters

Name	In	Type	Required
`domain_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`stage`	string or null	no
`pinned`	boolean or null	no

Responses

Section titled Domain records

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Domain records

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains/{domain_id}/records

Parameters

Name	In	Type	Required
`domain_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Verify domain

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Verify domain

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains/{domain_id}/verify

Parameters

Name	In	Type	Required
`domain_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled List events

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

List events

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/events

Parameters

Name	In	Type	Required	Description
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes
`category`	query	string or null	no
`recipient`	query	string or null	no
`hours`	query	integer	no	Default: `24`.
`limit`	query	integer	no	Default: `100`.

Responses

Section titled Request limit increase

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Request limit increase

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/limits/increase-request

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required	Description
`requested_per_hour`	integer	yes
`reason`	string	no	What the relay sends and why the volume is going up

Responses

Section titled List mailboxes

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

List mailboxes

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Create mailbox

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Create mailbox

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`domain_id`	integer	yes
`local_part`	string	yes
`password`	string or null	no
`display_name`	string or null	no
`quota_bytes`	integer or null	no

Responses

Section titled Delete mailbox

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Delete mailbox

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Mailbox app passwords

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox app passwords

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/app-passwords

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Mailbox app password create

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox app password create

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/app-passwords

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`label`	string	no

Responses

Section titled Mailbox app password delete

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox app password delete

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/app-passwords/{credential_id}

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`credential_id`	path	string	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Mailbox enabled

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox enabled

PATCH /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/enabled

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`enabled`	boolean	yes

Responses

Section titled Mailbox imports

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox imports

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/imports

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Mailbox import start

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox import start

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/imports

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`preset`	string	no
`host`	string or null	no
`username`	string	yes
`password`	string	yes
`folders`	array of string	no
`since`	string (date) or null	no
`until`	string (date) or null	no
`trash`	boolean	no
`spam`	boolean	no

Responses

Section titled Mailbox import sign in

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox import sign in

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/imports/oauth

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`provider`	string, one of `google`, `microsoft`	yes
`return_path`	string or null	no
`since`	string (date) or null	no
`until`	string (date) or null	no
`trash`	boolean	no
`spam`	boolean	no

Responses

Section titled Mailbox import upload

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox import upload

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/imports/upload

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Request body

multipart/form-data (required)

Field	Type	Required
`file`	string (binary)	yes
`kind`	string	no
`folder`	string	no
`cpanel_mailbox`	string	no
`trash`	boolean	no
`spam`	boolean	no

Responses

Section titled Mailbox import steer

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox import steer

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/imports/{import_id}/{action}

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`import_id`	path	integer	yes
`action`	path	string, one of `pause`, `resume`, `cancel`	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Mailbox password

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox password

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/password

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`password`	string or null	no

Responses

Section titled Mailbox quota

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox quota

PATCH /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/quota

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`quota_bytes`	integer	yes

Responses

Section titled Mailbox sessions

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox sessions

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/sessions

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Mailbox sessions end

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox sessions end

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/sessions

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Mailbox session end

Status	Meaning
`204`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox session end

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/sessions/{session_id}

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`session_id`	path	string	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Mailbox totp enable

Status	Meaning
`204`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox totp enable

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/totp

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Mailbox totp disable

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox totp disable

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/totp

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Send message

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Send message

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/messages

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`from`	string	yes
`from_name`	string or null	no
`to`	array of string	yes
`cc`	array of string	no
`subject`	string	no
`text`	string or null	no
`html`	string or null	no
`reply_to`	string or null	no
`headers`	Headers	no
`category`	string or null	no

Responses

Section titled Reputation report

Status	Meaning
`202`	Success.
`422`	The request is not valid. `detail` lists each problem.

Reputation report

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/reputation

Parameters

Name	In	Type	Required	Description
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes
`limit`	query	integer	no	Default: `50`.

Responses

Section titled List suppressions

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

List suppressions

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/suppressions

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Add suppression

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Add suppression

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/suppressions

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`address`	string	yes

Responses

Section titled Remove suppression

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Remove suppression

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/suppressions/{suppression_id}

Parameters

Name	In	Type	Required
`suppression_id`	path	integer	yes
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes

Responses

Section titled Usage report

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Usage report

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/usage

Parameters

Name	In	Type	Required	Description
`org_slug`	path	string	yes
`tenant_id`	path	integer	yes
`days`	query	integer	no	Default: `30`.

Responses