Help Center/ CodeArts Req/ API Reference/ APIs/ User Information/ Updating the Nickname of a Subuser
Updated on 2023-06-12 GMT+08:00

Updating the Nickname of a Subuser

Function

A user with the te_admin role can update the nicknames of other users.

URI

PUT /v4/domain/child-users

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User Token

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

users

Yes

Array of UpdateChildUserNickNameRequestBody objects

List of modified users.

Table 3 UpdateChildUserNickNameRequestBody

Parameter

Mandatory

Type

Description

nick_name

Yes

String

Nickname of the user.

user_id

Yes

String

User ID

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Description

error_code

String

Error Codes

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Description

error_code

String

Error Codes

Example Requests

PUT https://{endpoint}/v4/domain/child-users

{
  "users" : [ {
    "nick_name" : "Tom",
    "user_id" : "08777d423500d4b01fe5c008d04336ab"
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

204

No Content

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.