Add agent
POST {{baseUrl}}/api/v1/agents
This API adds an agent to your help desk.
OAuth Scope
Desk.settings.CREATEDesk.basic.CREATE
Attributes
| Attribute Name | Data Type | Description |
|---|---|---|
| emailId (required) | <string> max chars : 100 | Email ID of the agent |
| lastName (required) | <string> max chars : 50 | Last name of the agent |
| firstName | <string> max chars : 50 | First name of the agent |
| phone | <string> max chars : 100 | Phone number of the agent |
| mobile | <string> max chars : 100 | Mobile number of the agent |
| extn | <string> max chars : 100 | Extension number of the agent |
| associatedDepartmentIds (required) | <list> | Departments with which the agent is associated |
| associatedChatDepartmentIds | <list> | Chat departments with which the agent is associated |
| rolePermissionType (required) | <string> max chars : 100 | The Role Permission type of Agent |
| aboutInfo | <string> max chars : 255 | Agent's about info |
| channelExpert | <list> | The channels handled for the Agent |
| countryCode | <string> max chars : 100 | Country code of the agent. Agents can update only their countryCode. They cannot update the countryCode of other users. |
| timeZone | <string> max chars : 100 | The timeZone of the agent. Eg Asia/Calcutta, Europe/Moscow. One can update his own timeZone only. If it is passed for other agent it will be ignored. |
| langCode | <string> max chars : 100 | Language code of the agent. Agents can update only their langCode. They cannot update the langCode of other users. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"lastName":"Walsh","extn":"","roleId":"1892000000056099","langCode":"fr_FR","mobile":"","timeZone":"Pacific/Majuro","emailId":"marisol51@zylker.com","associatedChatDepartmentIds":[],"zuid":"","associatedDepartmentIds":["1892000000006907","1892000000082069"],"firstName":"Marisol","photoURL":null,"phone":"","profileId":"1892000000056091","countryCode":"en_US","channelExpert":[],"name":"Walsh Marisol","rolePermissionType":"Admin","isConfirmed":true,"aboutInfo":"","id":"1892000000056007","status":"ACTIVE"}