GetMX-API

Add Alias

POST

/v1/alias/create

domain_id AND group_pay_id can't both empty

Request

Body Params multipart/form-data

token

string

required

Token generated by the management backend.

Example:

domain_id

string

optional

Domain ID (can be obtained from the GetMX management backend or through the /v1/domain/list endpoint; the 'id' field is the 'domain_id')

Example:

12345678

group_pay_id

string

optional

Group pay ID (group_pay_id can be obtained from the GetMX backend or through the /v1/group-pay/list endpoint, with the 'id' field corresponding to 'group_pay_id').

Example:

12345678

source

string

optional

Alias rule

Example:

{all}@mail.com

destination

string

optional

Alias receive email

Example:

[email protected]

mark

string

optional

Mark

Example:

mark

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://domain-open-api.getmx.com/v1/alias/create' \
--form 'token="token"' \
--form 'domain_id="12345678"' \
--form 'group_pay_id="12345678"' \
--form 'source="{all}@mail.com"' \
--form 'destination="[email protected]"' \
--form 'mark="mark"'

Responses

🟢200成功

application/json

Body

code

integer

required

msg

string

required

data

null

required

Example

{
  "code": 0,
  "msg": "string",
  "data": null
}

Get Aliases

Delete Alias