×

The Create User API allows administrators to create new users in the Contact Center system programmatically.
This API is typically used to onboard agents, supervisors, or system users by defining their credentials, roles, and access configurations.

It helps automate user provisioning during setup, integration, or scaling of large contact center deployments, ensuring consistent configuration across environments.

Key Capabilities

  • Create a new user with required attributes such as user ID, name, contact center ID, and user type.
  • Define user roles and access levels (e.g., Agent, Supervisor, Administrator).
  • Configure optional parameters like default ready state, login policy, and mapping IDs.
  • Add metadata such as description or mapping with an external CRM or system user.
  • Returns a confirmation with the newly created user’s unique identifier.
POST

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

The following are the POST parameters sent as raw in the Body of the Request:

 

Parameter Name

 Type Description
userId

string

 Unique user identifier in CC. This is what you’ll later use to map to external systems.
userType string Business role of the user e.g. Agent, Supervisor, Executive, Professional Agent. 
userName string Display name of the user.
systemUserType string System-level type, often same as userType.
defaultReady boolean Whether the agent should log in as “Ready” by default.
userData string Extra data / notes.
contactCenterId integer CC id in which to create this user.
description string Free-text description.
loginPolicy string e.g. disallow.after.limit or verify.before.force.login.
maxAllowedLogins string Max concurrent logins. Store as string for backward compatibility (as per your schema).
mappingUserId string Mapping to external app login (email/SSO id).
  • Example Request
curl --location 'https://cxdemo.ameyo.com:8443/ameyorestapi/cc/contactCenterUsers' \
--header 'sessionId: d898-690087a3-ses-doc_admin-cjtO7ersOpDcT0egpwJYV0nbktd2nVMtgiY2NaiWyeBtjO6E4yqlAJaQ7EpHm64a0f4slzAqjozcdByHxTgH8H39UGJnQNmcATGzJTAD6G0DQrXOFgpB-1339' \
--header 'Content-Type: application/json' \
--header 'Cookie: __METADATA__=b84809ab-9449-4ccb-86c0-2fcc0e21440f' \
--data-raw '{
"userId": "abcd",
"userType": "Supervisor",
"userName": "Sharanya Pathikonda",
"contactCenterId": 1,
"userData": "password",
"defaultReady": true,
"systemUserType": "Supervisor",
"loginPolicy": "verify.before.force.login",
"maxAllowedLogins": "1",
"mappingUserId": "testuser@gamil.com",
"description": "test user"
}'
  • Example Response
{  "ccUserId": 364, 
 "userId": "tesUser", 
 "userType": "Supervisor", 
 "skillLevelIds": [], 
 "skillIds": null, 
 "userName": "tesUser", 
 "systemUserType": "Supervisor",  "privilegePlanId": 13,  "defaultReady": false, 
 "maskedPrivileges": null, 
 "maxAllowedLogins": null, 
 "loginPolicy": null, 
 "mappingUserId": null

}

HTTP Response:

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