×

The Delete User API allows administrators to permanently remove an existing user from the Contact Center system.
This API is typically used to deprovision inactive agents, revoke access for users who have left the organization, or clean up test or duplicate accounts.

Once deleted, the user’s access credentials become invalid, and the user can no longer log in or be assigned to any queues, campaigns, or roles.

Key Capabilities

  • Delete an existing user from the Contact Center system.
  • Automatically revoke associated sessions and access credentials.
  • Useful for deprovisioning, account cleanup, and compliance management.
  • Requires a valid Session ID for authentication.
DELETE

<Protocol>://<IP_Domain_Name>:<port>/ameyorestapi/user/users/{userId}

Request Headers

Header Name                                                                            Description
sessionId Valid Session ID obtained from the Login API. Used to authenticate the delete request.
Content-Type (Optional) Indicates the media type of the request. Usually application/json.

Path Parameter

Parameter Name     Type                                                                            Description
userId     string Unique identifier of the user to be deleted from the Contact Center system.
  • Example Request
curl --location --request DELETE '<Protocol>://<IP_Domain_Name>:<port>/ameyorestapi/user/users/abcd' \
--header 'sessionId: <your-session-id>'
  • Example Respone
{
"status": "success",
"message": "User deleted successfully",
"userId": "abcd"
}