Update Email

POST

/v1/mail/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:

mail_id

string

required

Mail ID (can be obtained from the GetMX management backend or through the /v1/mail/list endpoint; the 'id' field is the 'mail_id').

Example:

12345678

password

string

optional

Password, must be at least 8 characters in length; do not upload the password parameter if no change is intended

Example:

@1!2%345678

mark

string

optional

Remark, do not upload the mark parameter if no change is intended

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/mail/update' \
--form 'token="token"' \
--form 'mail_id="12345678"' \
--form 'password="@1!2%345678"' \
--form 'mark="mark"'

Responses

🟢200成功

application/json

Body

code

integer

required

msg

string

required

data

object

required

Example

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

Modified at 2024-12-03 00:48:52

Delete Email

Clean up Email