Update team role

Updates the details of a team role

patch/api/{cloudId}/v1/teams/{teamId}/roles/{identifier}

Path parameters

identifierstring required

Id of the team role.

teamId'id' | 'name' required

Id of the team.

Request body

namestring

The name of the custom user role.

Example request

{
  "name": "updatedRole",
  "rights": [
    {
      "right": "access-reports",
      "granted": true
    },
    {
      "right": "delete-escalations",
      "granted": false
    }
  ]
}

Response

Returned if the request is successful.

idstring

The id of the team role.

namestring

The name of the team role.

Changes

No recorded changes to this endpoint across all 3 revisions of this API.