Update agent
PATCH {{baseUrl}}/api/v1/agents/:agent_id
This API updates details of an agent.
OAuth Scope
Desk.settings.UPDATEDesk.basic.UPDATE
Attributes
| Attribute Name | Data Type | Description |
|---|---|---|
| emailId | <string> max chars : 100 | Email ID of the agent |
| lastName | <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 | <list> | Departments with which the agent is associated |
| associatedChatDepartmentIds | <list> | Chat departments with which the agent is associated |
| rolePermissionType | <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":"Marisol Walsh","extn":"3298","roleId":"1892000000056099","langCode":"fr_FR","mobile":"","timeZone":"Pacific/Majuro","emailId":"marisol51@zylker.com","associatedChatDepartmentIds":[],"zuid":"10687231","associatedDepartmentIds":["1892000000006907","1892000000082069"],"firstName":"K","photoURL":null,"phone":"764-484-8068","profileId":"1892000000056091","countryCode":"en_US","channelExpert":["Facebook","Email","Forums"],"name":"K Marisol Walsh","rolePermissionType":"Admin","isConfirmed":true,"aboutInfo":"Expert in handling Reports","id":"1892000000056007","status":"ACTIVE"}