Add department
POST {{baseUrl}}/api/v1/departments
This API adds a department to your help desk portal.
OAuth Scope
Desk.settings.CREATEDesk.basic.CREATE
Attributes
| Attribute Name | Data Type | Description |
|---|---|---|
| name (required) | <string> max chars : 150 | Name of the department |
| nameInCustomerPortal | <string> max chars : 150 | Display name of the department in the help center |
| description | <string> max chars : 500 | A short description of the department |
| isVisibleInCustomerPortal | <boolean> | Key that denotes if the department is visible in the help center or not |
| isAssignToTeamEnabled | <boolean> | Key that denotes if the assign to team functionality is enabled or not |
| associatedAgentIds (required) | <list> | IDs of agents associated with the department |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"isAssignToTeamEnabled":false,"chatStatus":"NOT_CREATED","hasLogo":false,"isVisibleInCustomerPortal":true,"creatorId":"1892000000042001","description":"With the most advanced technology, the zPhone is the world’s largest selling smartphone.","associatedAgentIds":["1892000000042001","1892000000056007"],"isDefault":false,"isEnabled":true,"name":"zPhone","createdTime":"2019-07-26T13:11:02.000Z","id":"1892000000082085","nameInCustomerPortal":"zPhone"}