# Organization API: Org Mail: Mail

> The 45 Organization API operations for mail.

Source: https://docs.coritan.com/api/reference/organizations/org-mail/mail/

Part of [Org Mail](/api/reference/organizations/org-mail/).

## Operations

| Method | Path | Summary |
| --- | --- | --- |
| GET | [`/api/v1/orgs/{org_slug}/mail/overview`](#op-get-api-v1-orgs-org-slug-mail-overview) | Org mail overview |
| GET | [`/api/v1/orgs/{org_slug}/mail/tenants`](#op-get-api-v1-orgs-org-slug-mail-tenants) | List org tenants |
| GET | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}`](#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id) | Get summary |
| GET | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/aliases`](#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-aliases) | List aliases |
| POST | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/aliases`](#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-aliases) | Create alias |
| DELETE | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/aliases/{account_id}`](#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-aliases-account-id) | Delete alias |
| PATCH | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/category`](#op-patch-api-v1-orgs-org-slug-mail-tenants-tenant-id-category) | Set category |
| GET | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/credentials`](#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-credentials) | List credentials |
| POST | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/credentials`](#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-credentials) | Create credential |
| DELETE | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/credentials/{account_id}`](#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-credentials-account-id) | Delete credential |
| PATCH | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/credentials/{account_id}/enabled`](#op-patch-api-v1-orgs-org-slug-mail-tenants-tenant-id-credentials-account-id-enabled) | Credential enabled |
| POST | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/credentials/{account_id}/rotate`](#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-credentials-account-id-rotate) | Rotate credential |
| GET | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains`](#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-domains) | List domains |
| POST | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains`](#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-domains) | Add domain |
| DELETE | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains/{domain_id}`](#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-domains-domain-id) | Remove domain |
| PATCH | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains/{domain_id}/dmarc`](#op-patch-api-v1-orgs-org-slug-mail-tenants-tenant-id-domains-domain-id-dmarc) | Set DMARC |
| GET | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains/{domain_id}/records`](#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-domains-domain-id-records) | Domain records |
| POST | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains/{domain_id}/verify`](#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-domains-domain-id-verify) | Verify domain |
| GET | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/events`](#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-events) | List events |
| POST | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/limits/increase-request`](#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-limits-increase-request) | Request limit increase |
| GET | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes`](#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes) | List mailboxes |
| POST | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes`](#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes) | Create mailbox |
| DELETE | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}`](#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id) | Delete mailbox |
| GET | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/app-passwords`](#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-app-passwor) | Mailbox app passwords |
| POST | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/app-passwords`](#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-app-passwo) | Mailbox app password create |
| DELETE | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/app-passwords/{credential_id}`](#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-app-pass) | Mailbox app password delete |
| PATCH | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/enabled`](#op-patch-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-enabled) | Mailbox enabled |
| GET | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/imports`](#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-imports) | Mailbox imports |
| POST | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/imports`](#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-imports) | Mailbox import start |
| POST | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/imports/oauth`](#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-imports-oa) | Mailbox import sign in |
| POST | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/imports/upload`](#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-imports-up) | Mailbox import upload |
| POST | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/imports/{import_id}/{action}`](#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-imports-im) | Mailbox import steer |
| POST | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/password`](#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-password) | Mailbox password |
| PATCH | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/quota`](#op-patch-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-quota) | Mailbox quota |
| GET | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/sessions`](#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-sessions) | Mailbox sessions |
| DELETE | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/sessions`](#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-sessions) | Mailbox sessions end |
| DELETE | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/sessions/{session_id}`](#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-sessions) | Mailbox session end |
| POST | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/totp`](#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-totp) | Mailbox totp enable |
| DELETE | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/totp`](#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-totp) | Mailbox totp disable |
| POST | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/messages`](#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-messages) | Send message |
| GET | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/reputation`](#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-reputation) | Reputation report |
| GET | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/suppressions`](#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-suppressions) | List suppressions |
| POST | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/suppressions`](#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-suppressions) | Add suppression |
| DELETE | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/suppressions/{suppression_id}`](#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-suppressions-suppression-id) | Remove suppression |
| GET | [`/api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/usage`](#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-usage) | Usage report |

### Org mail overview {#op-get-api-v1-orgs-org-slug-mail-overview}

`GET /api/v1/orgs/{org_slug}/mail/overview`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `org_slug` | path | string | yes |

#### Responses

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

### List org tenants {#op-get-api-v1-orgs-org-slug-mail-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

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

### Get summary {#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id}

`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

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

### List aliases {#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-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

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

### Create alias {#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-aliases}

`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

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

### Delete alias {#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-aliases-account-id}

`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

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

### Set category {#op-patch-api-v1-orgs-org-slug-mail-tenants-tenant-id-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

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

### List credentials {#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-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

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

### Create credential {#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-credentials}

`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

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

### Delete credential {#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-credentials-account-id}

`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

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

### Credential enabled {#op-patch-api-v1-orgs-org-slug-mail-tenants-tenant-id-credentials-account-id-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

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

### Rotate credential {#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-credentials-account-id-rotate}

`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

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

### List domains {#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-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

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

### Add domain {#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-domains}

`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

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

### Remove domain {#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-domains-domain-id}

`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 {#op-patch-api-v1-orgs-org-slug-mail-tenants-tenant-id-domains-domain-id-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

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

### Domain records {#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-domains-domain-id-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

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

### Verify domain {#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-domains-domain-id-verify}

`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

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

### List events {#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-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

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

### Request limit increase {#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-limits-increase-request}

`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

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

### List mailboxes {#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-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

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

### Create mailbox {#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes}

`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

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

### Delete mailbox {#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id}

`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

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

### Mailbox app passwords {#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-app-passwor}

`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

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

### Mailbox app password create {#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-app-passwo}

`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

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

### Mailbox app password delete {#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-app-pass}

`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

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

### Mailbox enabled {#op-patch-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-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

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

### Mailbox imports {#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-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

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

### Mailbox import start {#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-imports}

`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

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

### Mailbox import sign in {#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-imports-oa}

`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

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

### Mailbox import upload {#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-imports-up}

`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

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

### Mailbox import steer {#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-imports-im}

`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

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

### Mailbox password {#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-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

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

### Mailbox quota {#op-patch-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-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

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

### Mailbox sessions {#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-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

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

### Mailbox sessions end {#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-sessions}

`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

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

### Mailbox session end {#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-sessions}

`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

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

### Mailbox totp enable {#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-totp}

`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

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

### Mailbox totp disable {#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-mailboxes-account-id-totp}

`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

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

### Send message {#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-messages}

`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

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

### Reputation report {#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-reputation}

`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

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

### List suppressions {#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-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

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

### Add suppression {#op-post-api-v1-orgs-org-slug-mail-tenants-tenant-id-suppressions}

`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

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

### Remove suppression {#op-delete-api-v1-orgs-org-slug-mail-tenants-tenant-id-suppressions-suppression-id}

`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

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

### Usage report {#op-get-api-v1-orgs-org-slug-mail-tenants-tenant-id-usage}

`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

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