Qodex.ai

Update role

PATCH {{baseUrl}}/api/v1/roles/:role_id

This API updates details of an existing role.

OAuth Scope

  • Desk.settings.UPDATE
  • Desk.basic.UPDATE

Attributes

Attribute NameData TypeDescription
name<string>
max chars : 50		Name of the role
description<string>
max chars : 3200		A short description of the role
shareDataWithPeers<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

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;isDefault&quot;:false,&quot;shareDataWithPeers&quot;:true,&quot;immediateSubRoles&quot;:[],&quot;name&quot;:&quot;Customer Care and Sales Associate&quot;,&quot;description&quot;:&quot;Can work on own tickets and can not re-assign tickets.&quot;,&quot;reportsTo&quot;:5000000008807,&quot;id&quot;:&quot;5000000002973&quot;,&quot;isVisible&quot;:true}