post https://refer-base-url-sub-domains.imi.chat/v3.1/users
This endpoint allows you to create users of role type: Customer Care and assign roles to the user within each .
Request Body Params:
| Param Name | Data Type | Description |
|---|---|---|
| first_name | string | First name of the user |
| last_name | string | Last name of the user |
| login_id | string | Login ID of the user |
| email_id | string | Email ID of the user |
| password | string | Set the password of the user |
| job_description | string | Job description of the user |
| login_using_email | boolean | States whether the user is allowed to login using email address |
| privileges | ARRAY - Privilege OBJECT | ARRAY of the privilege object containing a map of the teamid and role assigned in each of the team to the user |
| skill_attributes | OBJECT | A JSON object containing skill attributes of the user. |
| active_chats | integer | No. of chats being handled by the user in his/her My Chats currently |
Response Body Params:
| Param Name | Data Type | Description |
|---|---|---|
| teamid | integer | Unique identifier of the team |
| role | enum | Role to be assigned to the user: - Team Manager- Team Agent- Team Analyst |
Note
This API endpoint only allows creating users of role type:
Customer Care- in other words, team level users alone. Creating Administrative Users is not supported currently
Response Body Params:
| Param Name | Description |
|---|---|
| status_code | Denotes the status of the response. Detailed guide can be found here |
| description | States the description of the status_code. Gives you information about the success/error |
| response | Contains details of the current resource fetched/updated/created |
User OBJECT:
| Param Name | Data Type | Description |
|---|---|---|
| id | integer | Unique identifier of a user |
| created_at | datetime - UTC format | Datetime when the user was created on the application |
| created_at | datetime - UTC format | Datetime when the user was last updated on the application |
| first_name | string | First name of the user |
| last_name | string | Last name of the user |
| login_id | string | Login ID of the user |
| email_id | string | Email ID of the user |
| status | enum | Current status of the user: - active- inactive |
| logged_in | boolean | States whether the user is currently logged into the application |
| job_description | string | Job description of the user |
| login_using_email | boolean | States whether the user is allowed to login using email address |
| role_type | enum | Role Type of the user: - Customer Care- Administrative |
| accepting_chats | boolean | States whether the user is ready to accept chats currently |
| skill_attributes | OBJECT | A JSON object containing skill attributes of the user. |
| active_chats | integer | No. of chats being handled by the user in his/her My Chats currently |
Response Codes
| status_code | HTTP Status | Description |
|---|---|---|
| 4308 | 200 | User created successfully |
| 2002 | 400 | Invalid header param - could not find mandatory header parameters |
| 2003 | 400 | Invalid Access Token |
| 2004 | 401 | Access Token expired |
| 2007 | 500 | Internal Server Error |
| 2010 | 404 | Could not find details of team based on the teamid passed in the header |
| 2099 | 405 | Method not allowed |
| 3102 | 409 | The requested user already exists |
| 3107 | 400 | The value provided for the custom attribute 'business' is not valid |
| 3110 | 400 | The value provided for the custom attribute 'location' is not valid |
| 3111 | 400 | The email id already exists in the system |
| 3114 | 400 | Request body not provided |
| 3115 | 400 | Request is invalid |