Create role
POST {{baseUrl}}/api/v1/roles
This API creates a role in your help desk.
OAuth Scope
Desk.settings.CREATEDesk.basic.CREATE
Attributes
| Attribute Name | Data Type | Description |
|---|---|---|
| name (required) | <string> max chars : 50 | Name of the role |
| description | <string> max chars : 3200 | A short description of the role |
| shareDataWithPeers (required) | <boolean> | Key that denotes if the role shares data with its peer roles |
| reportsTo | <long> | ID of the role to which the current role reports |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"isDefault":false,"shareDataWithPeers":true,"immediateSubRoles":[],"name":"Customer Care Associate","description":"Can work on own tickets and can not re-assign tickets.","reportsTo":5000000008807,"id":"5000000002973","isVisible":true}