Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ User/ Updating an Email Address
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Updating an Email Address

Function

This API is used to update an email address.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsrepo::updateUserSetting

Write

-

-

-

-

URI

PUT https://{hostURL}/v4/user/emails

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints

N/A

Range

1–100,000 characters.

Default Value

N/A
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

email

No

String

Definition

Email address.

Range

1–1,000 characters.

verify_code

No

String

Definition

Verification code.

Range

1–1,000 characters.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

Integer

Definition

User ID.

Value range:

1~2147483647

name

String

Definition

Username.

Range

1–1,000 characters.

username

String

Definition

Long user ID.

Range

1–1,000 characters.

state

String

Definition:

User status. active: active user; blocked: locked user

Default value:

active

Enumeration values:

  • active

  • blocked

created_at

String

Definition

Creation time.

Range

1–1,000 characters.

updated_at

String

Definition

Update time.

Range

1–1,000 characters.

last_activity_on

String

Definition

Last active time.

Range

1–1,000 characters.

commit_email

String

Definition

Commit email.

Range

1–1,000 characters.

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

PUT https://{endpoint}/v4/user/emails

{
  "email" : "11@email.com",
  "verify_code" : "SFLAJA"
}

Example Responses

Status code: 200

OK

{
  "id" : 21820,
  "name" : "tr8",
  "username" : "ac105e52a4764a4c8f29b306508f016d",
  "state" : "active",
  "created_at" : "2025-03-27T14:17:11.000+08:00",
  "updated_at" : "2025-05-20T15:42:31.351+08:00",
  "last_activity_on" : "2025-05-17",
  "commit_email" : "1@email.com"
}

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

Error Codes

See Error Codes.

Parent topic: User