Update Alias

POST

/v1/alias/update

At least one parameter to be modified must be provided; do not include parameters that do not require changes in the request.

Request

Body Params multipart/form-data

token

string

required

Token generated by the management backend.

Example:

alias_id

string

required

Rule ID (can be obtained from the GetMX management backend or through the /v1/alias/list endpoint; the 'id' field is the 'alias_id').

Example:

12345678

status

integer

optional

Status, -1 for disabled, 1 for enabled

Example:

-1

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/update' \
--form 'token="token"' \
--form 'alias_id="12345678"' \
--form 'status="-1"' \
--form 'mark="mark"'

Responses

🟢200成功

application/json

Body

code

integer

required

msg

string

required

data

null

required

Example

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

Delete Alias

Get Message Notices