Mutations
updateCustomRole
Updates the name and/or description of an existing custom role. Only the fields provided in the input are changed. Requires the roles:edit permission.
MUTATION
updateCustomRole(input: UpdateCustomRoleInput!): UpdateCustomRoleOutput!Arguments
input
required
Returns
role
error
Mutation
mutation UpdateCustomRole($input: UpdateCustomRoleInput!) {
updateCustomRole(input: $input) {
role {
id
name
description
permissionsPreset
scopeDefinitions {
resource
scopes {
__typename
}
}
createdAt {
unixTimestamp
iso8601
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"customRoleId": "id"
}
}Response
{
"data": {
"updateCustomRole": {
"role": {
"id": "id",
"name": "string",
"description": "string",
"permissionsPreset": "string",
"scopeDefinitions": [
{
"resource": "THREAD",
"scopes": [
{
"__typename": "RoleScope"
}
]
}
],
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Was this page helpful?
⌘I
Mutation
mutation UpdateCustomRole($input: UpdateCustomRoleInput!) {
updateCustomRole(input: $input) {
role {
id
name
description
permissionsPreset
scopeDefinitions {
resource
scopes {
__typename
}
}
createdAt {
unixTimestamp
iso8601
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"customRoleId": "id"
}
}Response
{
"data": {
"updateCustomRole": {
"role": {
"id": "id",
"name": "string",
"description": "string",
"permissionsPreset": "string",
"scopeDefinitions": [
{
"resource": "THREAD",
"scopes": [
{
"__typename": "RoleScope"
}
]
}
],
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}
