/mail/domains/{id}/aliases (POST)

POST

/mail/domains/{id}/aliases

curl --request POST \
  --url https://example.com/api/v1/mail/domains/example/aliases \
  --header 'Content-Type: application/json' \
  --data '{ "alias": "example", "destinations": [ "example" ] }'

Parameters

Path Parameters

id

required

string

Request Body ^required

Media type application/json

object

alias

required

string

>= 1 characters <= 64 characters

destinations

required

Array<string>

>= 1 items <= 50 items

Example ^generated

{
  "alias": "example",
  "destinations": [
    "example"
  ]
}

Responses

201

Default Response

Media type application/json

object

id

required

string

alias

required

string

destinations

required

Array<string>

createdAt

required

string

Example ^generated

{
  "id": "example",
  "alias": "example",
  "destinations": [
    "example"
  ],
  "createdAt": "example"
}

404

Default Response

Media type application/json

object

type

required

string

title

required

string

status

required

integer

code

required

string

detail

string

instance

string

errors

Array<object>

object

path

required

string

message

required

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}