ROroblox
Groups

Creates new group roleset.

Changed on
post/v1/groups/{groupId}/rolesets/create

Request

  • Base URL
    https://groups.roblox.com
  • URL
    https://groups.roblox.com/v1/groups/{groupId}/rolesets/create
  • Auth
    API key in cookie .ROBLOSECURITY

Path parameters

groupIdinteger required

The group Id.

Request body

namestring

The name of the roleset.

descriptionstring

The description of the roleset.

rankinteger

The rank/positioning of the roleset.

usingGroupFundsboolean

Setting to use group funds or not.

isPrivateboolean

Optional. When true the role is only visible to members with permission to see private roles. Defaults to false (public). Only accessible to group owners.

Response

OK

idinteger

The role id

namestring

The role name

descriptionstring

The role description

rankinteger

The role rank

memberCountinteger

The number of members in the role.

isBaseboolean

Whether or not the role is the base role for the group

color0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16

The role color. ['Invalid' = 0, 'Blue' = 1, 'Green' = 2, 'Purple' = 3, 'Yellow' = 4, 'Orange' = 5, 'Red' = 6, 'Magenta' = 7, 'Teal' = 8, 'Turquoise' = 9, 'Rust' = 10, 'Pistachio' = 11, 'Midnight' = 12, 'Lavender' = 13, 'Pink' = 14, 'Crimson' = 15, 'Plum' = 16]

isPrivateboolean

Whether the role is private (only visible to members with permission). Omitted from the response when false.

Changes