A request model for changing the group owner.

A request model for creating a group wall post

If set to true, default group emblem policies handled by GUAC will be enabled
            
If set to false, default group emblem policies will not be enabled

The configuration of premium payouts shows in Group Revenue Summary page

The maximum length of a group description

The maximum file size of the group icon in megabytes

Should the frontend use the 2sv webview component (as opposed to the built-in 2sv pop up)

Whether the group is public (no approval required)

A model representing data about an Roblox.Platform.Membership.IUser

Permission to view universe analytics from the creator dashboard.

A model representing group posts permissions

Whether the group notification preferences are enabled for the user

Whether the group is the user's Primary Group

A user's group membership metadata response model

Whether the user is ban evading from the group

Whether the user is banned from the group

Whether the group's notification preferences set to enabled for the user

Whether there has been a request to join this group

The cooldown for group name changes in days

The ownership cooldown for group name changes in days

 ['AnnouncementCreatedNotification' = 0, 'ForumPostCreatedNotification' = 1, 'ForumCommentCreatedNotification' = 2, 'ForumCommentReplyCreatedNotification' = 3, 'ForumSubscriberNotification' = 4]

Permission to administer all of the group's API keys.

Permission to create and use API keys on the group's resources.

Response model for Group Payout Restriction

Whether the group can use one-time payout feature.

Whether the group can use recurring payout feature.

A group role's permissions response model

The index for the next page of related groups

The group relationship type ['Allies' = 1, 'Enemies' = 2]

The total number of groups for this relationship type

Response Model For Group Search Metadata Endpoint

Whether or not the Friends' Groups sort should show for the authenticated user

Suggested Group Category translation keys

When true anyone can join the group. When false manual approval
is required to join the group

Whether enemy club declarations are allowed.

If the group name change feature is enabled for this group.

If set to true, groups showcase will not show on users profiles.
            
If set to false, group showcase will display on users profiles.

Whether or not group notifications can be enabled

The user's current group membership count

The user's builders club membership group limit

Time in milliseconds between calls to subscribe to group wall notifications.

If set to true, group details will respect GUAC policies for group details
            
If set to false, group details will not respect GUAC policies

If set to true, group details will subscribe and respond to wall notifications.

Whether or not we should show previous names of this group

The user ids being either accepted or declined

A response model for group wall post information

When the group wall post was last updated.

The recipient type. ['User' = 0, 'Group' = 1]

The Roblox.Groups.Api.PayoutType. ['FixedAmount' = 1, 'Percentage' = 2]

A request model for setting the authenticated user's primary group.

A response model for recurring payout configuration

The maximum number of recurring payout partners

The group ids being either accepted or declined

A social link response from a create request

What type of social media (including Roblox Group) this points to ['Facebook' = 0, 'Twitter' = 1, 'YouTube' = 2, 'Twitch' = 3, 'GooglePlus' = 4, 'Discord' = 5, 'RobloxGroup' = 6, 'Amazon' = 7, 'Guilded' = 8]

A request model for setting a description for the group

A request model for setting a name for the group

A request model for updating a group's notification preference.

Whether the user wants to receive notifications from the group.

A request model for updating a group's settings.

A request model for updating a group's roleset's permissions.

The permission-value pairs to be updated.

A request model for setting a users role in a group.

The role in the group the user should be put into.

 ['None' = 0, 'GZip' = 1, 'Deflate' = 2, 'Brotli' = 4, 'All' = -1]

Groups Api v1

groupId

eventId

0: Token Validation Failed
3: User is not authorized to set featured content for this group.

Gets Group configuration contextual information

This endpoint will charge Robux for the group purchase.
Http status code 413 is thrown when the group icon file size is too large.

name

description

Whether or not the group is open for anyone to join.

publicGroup

Whether or not the group is only open to join for builders club members.

buildersClubMembersOnly

Files

13: The name is invalid.
15: The group icon is invalid.
16: The group icon is missing from the request.
18: The description is too long.
19: The name is too long.
20: The name has been taken.

0: Authorization has been denied for this request.

0: Token Validation Failed
10: User must have builders club membership.
11: User is in maximum number of groups.
12: Insufficient Robux funds.
14: The name is moderated.

21: Group creation is currently disabled.

1: Group is invalid or does not exist.
16: The group icon is missing from the request.
17: Too many requests.
30: Invalid file type for group icon.

0: Token Validation Failed
23: Insufficient permissions to complete the request.

Gets Groups contextual information:
Max number of groups a user can be part of.
Current number of groups a user is a member of.
Whether to show/hide certain features based on device type.

groupPolicyRequest

1: Too many ids in request.
2: Ids could not be parsed from request.

Gets group policy info used for compliance.

The keyword or phrase to use as the search parameter.

keyword

Whether or not to prioritize the exact match for the keyword (optional, defaults to false.

prioritizeExactMatch

limit

The paging cursor for the previous or next page.

cursor

2: Search term not appropriate for Roblox.
3: Search term was left empty.
4: Search terms can be 2 to 50 characters long.

Should only be used for direct lookups where a user is inputting a group name, shouldn't be used for search pages.

groupName

1: Name is missing or has invalid characters.

Looks up groups by a name. Prioritizes an exact match as the first result.

Although there is no reason for this to require an authenticated user right now, in the future,
we will use coco to return different suggested groups based upon that user's request context

5: No Localized Version of group search category exists

Get suggested groups and other miscellaneous information needed for the group/join page like flags

actionType

userId

sortOrder

1: Group is invalid or does not exist.
8: Invalid or missing pagination parameters

23: Insufficient permissions to complete the request.

changeOwnerRequest

1: The group is invalid or does not exist.
3: The user is invalid or does not exist.
15: User is not a member of the group.
16: The user does not have the necessary level of premium membership.

0: Token Validation Failed
17: You are not authorized to change the owner of this group.
25: 2-Step Verification is required to make further transactions. Go to Settings > Security to complete 2-Step Verification.

1: The group is invalid or does not exist.

0: Token Validation Failed
11: You are not authorized to claim this group
12: This group already has an owner
13: Too many attempts to claim groups. Please try again later.

18: The operation is temporarily unavailable. Please try again later.

Claims ownership of the group as the authenticated user

The Roblox.Groups.Api.UpdateGroupDescriptionRequest.

request

1: Group is invalid or does not exist.
29: Your group description was empty.

0: Token Validation Failed
18: The description is too long.
23: Insufficient permissions to complete the request.

1: The group is invalid or does not exist.
3: The user is invalid or does not exist.

19: You have insufficient permissions for this request.

Gets a page of Group Join Requests for a group.

1: The group is invalid or does not exist.
3: The user is invalid or does not exist.
20: The group join request is invalid.

0: Token Validation Failed
6: You are already in the maximum number of groups.
19: You have insufficient permissions for this request.

0: Token Validation Failed
4: You do not have permission to manage this member.

includeNotificationPreferences

Gets group membership information in the context of the authenticated user

This endpoint will charge Robux for the group rename.

The Roblox.Groups.Api.UpdateGroupNameRequest.

1: Group is invalid or does not exist.
13: The name is invalid.
19: The name is too long.
20: The name has been taken.

0: Token Validation Failed
12: Insufficient Robux funds.
14: The name is moderated.
23: Insufficient permissions to complete the request.
38: Your account must be verified in order to change your group's name.
39: The group ownership was changed too recently.

36: The name was changed too recently.
37: The name was in use too recently.

Roblox.Groups.Api.UpdateGroupSettingsRequest

 ['Unchanged' = 0, 'Created' = 1, 'Deleted' = 2, 'Updated' = 3]

9: You don't have permission to view this group's payouts.

Gets a value indicating whether the group can use payout feature

Gets a list of the group payout percentages

1: Group is invalid or does not exist.
12: Insufficient Robux funds.
24: Invalid payout type.
25: The amount is invalid.
26: Too many recipients.

0: Token Validation Failed
23: Insufficient permissions to complete the request.
28: Group has paid out too recently. Please wait and try again.
35: 2-Step Verification is required to make further transactions. Go to Settings > Security to complete 2-Step Verification.

This endpoint will remove any recipients not sent in the request.
If a recipient in the request is not a valid member in the group they will not be added to the recurring payouts.

1: Group is invalid or does not exist.
24: Invalid payout type.
25: The amount is invalid.
26: Too many recipients.
27: The recipients are invalid.

0: Token Validation Failed
12: Insufficient Robux funds.
28: Group has paid out too recently. Please wait and try again.
35: 2-Step Verification is required to make further transactions. Go to Settings > Security to complete 2-Step Verification.

The group relationship type, enemies or allies.

groupRelationshipType

StartRowIndex

The maximum number of rows for the page request, should be at least 1.

MaxRows

1: Group is invalid or does not exist.
4: Group relationship type or request type is invalid.
8: Invalid or missing pagination parameters

The type of group relationship being made

The Roblox.Groups.Api.RelationshipsRequest.

The group relationship type of the request, only allies are supported.

5: You don't have permission to manage this group's relationships.

Gets the permissions for a group's guest roleset. These can be viewed by all (members and guests) users.

roleSetId

1: Group is invalid or does not exist.
2: The roleset is invalid or does not exist.

3: You are not authorized to view/edit permissions for this role.

Gets the permissions for a group's roleset. The authorized user must either be the group owner or the roleset being requested, except for guest roles, which can be viewed by all (members and guests).

updatePermissionsRequest

0: Token Validation Failed
3: You are not authorized to view/edit permissions for this role.
4: This role's permissions can not be modified.

Updates the permissions for a group's roleset. The authorized user must be the group owner.

2: The roleset is invalid or does not exist.

Gets a list of users in a group for a specific roleset.

The Roblox.Groups.Api.Models.Request.CreateRoleSetRequest.

0: Something went wrong.
3: You do not have enough funds to purchase this role.
5: Role name already exists.
6: Rank value is out of bounds.
7: The role name is too long.
8: The role description is too long.
10: This group does not exist.
11: Failed to process payment to purchase role.
12: Limit for roles have been reached on this group.
14: Role name can not be empty.
15: This role does not exist.

0: Token Validation Failed
9: You do not have permissions to perform this action.

rolesetId

10: This group does not exist.
15: This role does not exist.
17: Cannot remove any more roles
18: Cannot delete this role.

0: Token Validation Failed
9: You do not have permissions to perform this action.
16: There are users in this role.

The Roblox.Groups.Api.Models.Request.UpdateRoleSetRequest.

5: Role name already exists.
6: Rank value is out of bounds.
7: The role name is too long.
8: The role description is too long.
10: This group does not exist.
14: Role name can not be empty.
15: This role does not exist.
19: Cannot update Guest role.
20: Cannot update Owner role rank.

13: Only users who are over thirteen years of age may edit social links.

11: Social links cannot be processed as this time.

Get social link data associated with a group

3: The social link title is too long.
4: The social link title cannot be empty.
5: The social link url cannot be empty.
7: The request was null.
9: The social link type is invalid.
12: The social link title was moderated.

0: Token Validation Failed
2: You do not have permission to configure this social link.

8: The requested group or social link was not found.

The id of the game you are editting, required for permissions checking

socialLinkId

1: Group is invalid or does not exist.
10: The social link is not for a group.
15: The social link id doesn't match the group id.

0: Token Validation Failed
2: You do not have permission to configure this social link.
13: Only users who are over thirteen years of age may edit social links.

1: Group is invalid or does not exist.
3: The social link title is too long.
4: The social link title cannot be empty.
5: The social link url cannot be empty.
6: The social link url was improperly formatted.
7: The request was null.
8: The requested group or social link was not found.
9: The social link type is invalid.
10: The social link is not for a group.
12: The social link title was moderated.
16: A social link with this type already exists on this group.

The Roblox.Groups.Api.PostGroupStatusRequest.

statusRequest

1: Group is invalid or does not exist.
7: Missing group status content.
32: Description was filtered.

0: Token Validation Failed
6: You are not authorized to set the status of this group

Only supplied when captcha has been solved.

joinGroupModel

0: Token Validation Failed
6: You are already in the maximum number of groups.
9: You do not have the builders club membership necessary to join this group.
14: You cannot join a closed group.

7: You have already requested to join this group.
8: You are already a member of this group.

10: Too many attempts to join the group. Please try again later.

0: Token Validation Failed
4: You do not have permission to manage this member.
25: 2-Step Verification is required to make further transactions. Go to Settings > Security to complete 2-Step Verification.

The Roblox.Groups.Api.UpdateUserRoleRequest.

1: The group is invalid or does not exist.
2: The roleset is invalid or does not exist.
3: The user is invalid or does not exist.
23: You cannot change your own role.
26: You cannot change the user's role to the same role.

Gets the permissions a user has in a group. Only available to group owner and RCC

2: You do not have permission to access this group wall.

The Roblox.Groups.Api.CreateWallPostRequest.

1: The group is invalid or does not exist.
5: Your post was empty, white space, or more than 500 characters.

0: Token Validation Failed
2: You do not have permission to access this group wall.

4: You are posting too fast, please try again in a few minutes.

postId

1: The group is invalid or does not exist.
3: The group wall post id is invalid or does not exist.

Groups v1