×

The Update User API allows administrators to modify an existing user’s details within the Contact Center.
It supports updating user information such as name, type, credentials, login policy, and mapping details — helping maintain accurate and up-to-date user configurations across the system.

This API is typically used when a user changes role, name, or login policy, or when credentials need to be reset programmatically.

Key Capabilities

  • Update existing user details, such as role, name, or contact center association.
  • Modify login policies, password, or allowed login configurations.
  • Map users to external systems like CRMs or workforce tools.
  • Enforce updates programmatically for large-scale user management.
PUT

<Protocol>://<IP_Domain_Name>:<port>/ameyorestapi/cc/contactCenterUsers/<userId>

Include the following parameters in your raw PUT request body when updating user details through this API:

Parameter Name Type Description
userId string Unique identifier of the user to be updated within the Contact Center.
userType string Defines the user’s access type (e.g., Agent, Supervisor, Analyst). Determines feature and role-based permissions.
userName string The display name of the user as it should appear in the Contact Center UI.
systemUserType string Specifies the internal system role for the user, aligned with Contact Center’s role management (e.g., Analyst, Supervisor).
defaultReady boolean If true, the user automatically moves to the “Ready” state upon login.
userData string The user’s password or credential data for authentication.
contactCenterId integer Unique ID of the Contact Center to which the user belongs.
loginPolicy string Defines the login behavior. Example: verify.before.force.login ensures validation before session override.
maxAllowedLogins integer Maximum number of concurrent sessions allowed for the user.
mappingUserId string External system mapping identifier (e.g., email or CRM user ID). Used for integrations with third-party systems.
  • Example Request
curl --location --request PUT '<Protocol>://<IP_Domain_Name>:<port>/ameyorestapi/cc/contactCenterUsers' \
--header 'sessionId: <your-session-id>' \
--header 'Content-Type: application/json' \
--data-raw '{
"userId": "30994",
"userType": "Analyst",
"userName": "Srajan",
"systemUserType": "Analyst",
"defaultReady": true,
"userData": "password",
"contactCenterId": 1,
"loginPolicy": "verify.before.force.login",
"maxAllowedLogins": 1,
"mappingUserId": "testUser@gmail.com"
}'
  • Example Response
{
"status": "success",
"message": "User updated successfully",
"userId": "30994",
"contactCenterId": 1,
"updatedFields": ["userName", "userType", "loginPolicy"]
}

HTTP Response:

  • On success, the HTTP response status code will be 200.