ModifyUser-阿里云帮助中心

You can invoke ModifyUser to modify the information of a specified agent under a specified instance. You can modify the phone number, work mode, role, and agent ID.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID.	ccc-test
UserId	string	Yes	Agent ID.	user-test@ccc-test
Mobile	string	No	Agent's personal phone number.	1382114****
WorkMode	string	Yes	Work mode. Valid values: ON_SITE : On-site mode OFF_SITE : Off-site mode OFFICE_PHONE : Office phone mode	ON_SITE
RoleId	string	No	Role ID, in the format: role@instance ID.	Admin@ccc-test
DisplayId	string	No	Agent ID (employee ID).	1001
DisplayName	string	No	User's full name.	张三疯
Force	boolean	No	Whether to force the modification.	true
Nickname	string	No	Agent nickname	老王
AvatarUrl	string	No	Agent profile picture URL.	http://abc.com/sam.jpb

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	HTTP status code.	200
Code	string	Response code.	OK
Message	string	Response message.	无
RequestId	string	Request ID.	EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Data	string	Data.	无
Params	array	Response parameters.
	string	Response parameters.	无

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "无",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Data": "无",
  "Params": [
    "无"
  ]
}

Error codes

HTTP status code	Error code	Error message
400	Parameter.Enumeration	The parameter %s must be one of the value of enumeration %s.
400	Parameter.Blank	The parameter %s may not be null or blank.
500	InternalService.Common	An internal service error occurred. %s
500	InternalService.DB	An internal DB service error occurred. %s
403	Permission.Common	You have no permission to access. %s
403	Permission.SkillGroup	You have no permission to access skill group(s) %s.
404	NotExists.InstanceId	The specified instance %s does not exist.
404	NotExists.RoleId	Role %s does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.