Client API: Mail: Aliases
The 3 Client API operations for aliases.
Part of Mail.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/client/mail/{service_id}/aliases |
List aliases |
| POST | /api/v1/client/mail/{service_id}/aliases |
Create alias |
| DELETE | /api/v1/client/mail/{service_id}/aliases/{account_id} |
Delete alias |
List aliases
Section titled List aliasesGET /api/v1/client/mail/{service_id}/aliases
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
service_id |
path | integer | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Create alias
Section titled Create aliasPOST /api/v1/client/mail/{service_id}/aliases
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
service_id |
path | integer | yes |
Request body
Section titled Request bodyapplication/json (required)
| Field | Type | Required |
|---|---|---|
domain_id |
integer | yes |
local_part |
string | yes |
targets |
array of string | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
201 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Delete alias
Section titled Delete aliasDELETE /api/v1/client/mail/{service_id}/aliases/{account_id}
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
account_id |
path | integer | yes |
service_id |
path | integer | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |