Skip to main content

CreateGroupRoleInput

Create a custom role within a group (team or channel), granting group permission keys.

input CreateGroupRoleInput {
  groupId: BigInt!
  roleName: String!
  permissions: [String!]
  rank: Int
}

Fields​

CreateGroupRoleInput.groupId ● BigInt! non-null scalar​

The group (team/channel) the role belongs to.

CreateGroupRoleInput.roleName ● String! non-null scalar​

Role display name (max 128 chars; unique within the group).

CreateGroupRoleInput.permissions ● [String!] list scalar​

Group permission key strings this role grants (e.g. manage_members, manage_roles, manage_group, send_messages). Must be valid keys for the group type; each max 64 chars, unique. Defaults to none.

CreateGroupRoleInput.rank ● Int scalar​

Sort/precedence rank (higher = more senior). Defaults to 0.

Member Of​

createChannelRole mutation ● createTeamRole mutation