# Client API: Mail: Aliases

> The 3 Client API operations for aliases.

Source: https://www.coritan.com/docs/api/reference/client/mail/platform-mail-aliases/

Part of [Mail](/docs/api/reference/client/mail/).

## Operations

| Method | Path | Summary |
| --- | --- | --- |
| GET | [`/api/v1/client/platform-mail/{tenant_id}/aliases`](#op-get-api-v1-client-platform-mail-tenant-id-aliases) | List aliases |
| POST | [`/api/v1/client/platform-mail/{tenant_id}/aliases`](#op-post-api-v1-client-platform-mail-tenant-id-aliases) | Create alias |
| DELETE | [`/api/v1/client/platform-mail/{tenant_id}/aliases/{account_id}`](#op-delete-api-v1-client-platform-mail-tenant-id-aliases-account-id) | Delete alias |

### List aliases {#op-get-api-v1-client-platform-mail-tenant-id-aliases}

`GET /api/v1/client/platform-mail/{tenant_id}/aliases`

Authentication: an access token, sent as `Authorization: Bearer <token>`.

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `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-client-platform-mail-tenant-id-aliases}

`POST /api/v1/client/platform-mail/{tenant_id}/aliases`

Authentication: an access token, sent as `Authorization: Bearer <token>`.

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `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-client-platform-mail-tenant-id-aliases-account-id}

`DELETE /api/v1/client/platform-mail/{tenant_id}/aliases/{account_id}`

Authentication: an access token, sent as `Authorization: Bearer <token>`.

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `account_id` | path | integer | yes |
| `tenant_id` | path | integer | yes |

#### Responses

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