Skip to main content

UpdateGroupRoleInput

Update a custom group role. Omitted fields are left unchanged.

input UpdateGroupRoleInput {
  groupRoleId: BigInt!
  roleName: String
  permissions: [String!]
  rank: Int
}

Fields​

UpdateGroupRoleInput.groupRoleId ● BigInt! non-null scalar​

The group role id to update.

UpdateGroupRoleInput.roleName ● String scalar​

New role name (max 128 chars). Ignored for system roles. Omit to leave unchanged.

UpdateGroupRoleInput.permissions ● [String!] list scalar​

When provided, REPLACES the role's permission key strings. Each must be a valid group permission key for the group type (max 64 chars, unique). Omit to leave permissions unchanged.

UpdateGroupRoleInput.rank ● Int scalar​

New rank (higher = more senior). Ignored for system roles. Omit to leave unchanged.

Member Of​

updateChannelRole mutation ● updateTeamRole mutation