ExilProductions/VRChatBackendDocs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
VRChatBackendDocs/Apis/GroupsApi.md
ExilProductions aa707d1deb add subdir
2026-02-15 17:39:26 +01:00

43 KiB
Raw Permalink Blame History

GroupsApi

All URIs are relative to https://api.vrchat.cloud/api/1

Method HTTP request Description
addGroupGalleryImage POST /groups/{groupId}/galleries/{groupGalleryId}/images Add Group Gallery Image
addGroupMemberRole PUT /groups/{groupId}/members/{userId}/roles/{groupRoleId} Add Role to GroupMember
addGroupPost POST /groups/{groupId}/posts Create a post in a Group
banGroupMember POST /groups/{groupId}/bans Ban Group Member
blockGroup POST /groups/{groupId}/block Block Group
cancelGroupRequest DELETE /groups/{groupId}/requests Cancel Group Join Request
cancelGroupTransfer DELETE /groups/{groupId}/transfer Cancel Group Transfer
createGroup POST /groups Create Group
createGroupAnnouncement POST /groups/{groupId}/announcement Create Group Announcement
createGroupGallery POST /groups/{groupId}/galleries Create Group Gallery
createGroupInvite POST /groups/{groupId}/invites Invite User to Group
createGroupRole POST /groups/{groupId}/roles Create GroupRole
declineGroupInvite PUT /groups/{groupId}/invites Decline Invite from Group
deleteGroup DELETE /groups/{groupId} Delete Group
deleteGroupAnnouncement DELETE /groups/{groupId}/announcement Delete Group Announcement
deleteGroupGallery DELETE /groups/{groupId}/galleries/{groupGalleryId} Delete Group Gallery
deleteGroupGalleryImage DELETE /groups/{groupId}/galleries/{groupGalleryId}/images/{groupGalleryImageId} Delete Group Gallery Image
deleteGroupInvite DELETE /groups/{groupId}/invites/{userId} Delete User Invite
deleteGroupPost DELETE /groups/{groupId}/posts/{notificationId} Delete a Group post
deleteGroupRole DELETE /groups/{groupId}/roles/{groupRoleId} Delete Group Role
getGroup GET /groups/{groupId} Get Group by ID
getGroupAnnouncements GET /groups/{groupId}/announcement Get Group Announcement
getGroupAuditLogEntryTypes GET /groups/{groupId}/auditLogTypes Get Group Audit Log Entry Types
getGroupAuditLogs GET /groups/{groupId}/auditLogs Get Group Audit Logs
getGroupBans GET /groups/{groupId}/bans Get Group Bans
getGroupGalleryImages GET /groups/{groupId}/galleries/{groupGalleryId} Get Group Gallery Images
getGroupInstances GET /groups/{groupId}/instances Get Group Instances
getGroupInvites GET /groups/{groupId}/invites Get Group Invites Sent
getGroupMember GET /groups/{groupId}/members/{userId} Get Group Member
getGroupMembers GET /groups/{groupId}/members List Group Members
getGroupPermissions GET /groups/{groupId}/permissions List Group Permissions
getGroupPosts GET /groups/{groupId}/posts Get posts from a Group
getGroupRequests GET /groups/{groupId}/requests Get Group Join Requests
getGroupRoleTemplates GET /groups/roleTemplates Get Group Role Templates
getGroupRoles GET /groups/{groupId}/roles Get Group Roles
getGroupTransferability GET /groups/{groupId}/transfer Get Group Transferability
initiateOrAcceptGroupTransfer POST /groups/{groupId}/transfer Initiate or Accept Group Transfer
joinGroup POST /groups/{groupId}/join Join Group
kickGroupMember DELETE /groups/{groupId}/members/{userId} Kick Group Member
leaveGroup POST /groups/{groupId}/leave Leave Group
removeGroupMemberRole DELETE /groups/{groupId}/members/{userId}/roles/{groupRoleId} Remove Role from GroupMember
respondGroupJoinRequest PUT /groups/{groupId}/requests/{userId} Respond Group Join request
searchGroupMembers GET /groups/{groupId}/members/search Search Group Members
searchGroups GET /groups Search Group
unbanGroupMember DELETE /groups/{groupId}/bans/{userId} Unban Group Member
updateGroup PUT /groups/{groupId} Update Group
updateGroupGallery PUT /groups/{groupId}/galleries/{groupGalleryId} Update Group Gallery
updateGroupMember PUT /groups/{groupId}/members/{userId} Update Group Member
updateGroupPost PUT /groups/{groupId}/posts/{notificationId} Edits a Group post
updateGroupRepresentation PUT /groups/{groupId}/representation Update Group Representation
updateGroupRole PUT /groups/{groupId}/roles/{groupRoleId} Update Group Role

addGroupGalleryImage

GroupGalleryImage addGroupGalleryImage(groupId, groupGalleryId, AddGroupGalleryImageRequest)

Add Group Gallery Image

Adds an image to a Group gallery.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
groupGalleryId String Must be a valid group gallery ID. [default to null]
AddGroupGalleryImageRequest AddGroupGalleryImageRequest

Return type

GroupGalleryImage

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

addGroupMemberRole

List addGroupMemberRole(groupId, userId, groupRoleId)

Add Role to GroupMember

Adds a Role to a Group Member

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
userId String Must be a valid user ID. [default to null]
groupRoleId String Must be a valid group role ID. [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

addGroupPost

GroupPost addGroupPost(groupId, CreateGroupPostRequest)

Create a post in a Group

Create a post in a Group.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
CreateGroupPostRequest CreateGroupPostRequest

Return type

GroupPost

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

banGroupMember

GroupMember banGroupMember(groupId, BanGroupMemberRequest)

Ban Group Member

Bans a user from a Group.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
BanGroupMemberRequest BanGroupMemberRequest

Return type

GroupMember

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

blockGroup

Success blockGroup(groupId)

Block Group

Blocks a Group for the current user. To unblock a group, call kickGroupMember (DELETE /groups/{groupId}/members/{userId}).

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]

Return type

Success

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

cancelGroupRequest

cancelGroupRequest(groupId)

Cancel Group Join Request

Cancels a request sent to join the group.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]

Return type

null (empty response body)

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

cancelGroupTransfer

Success cancelGroupTransfer(groupId)

Cancel Group Transfer

Cancel a Group Transfer.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]

Return type

Success

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

createGroup

Group createGroup(CreateGroupRequest)

Create Group

Creates a Group and returns a Group object. **Requires VRC+ Subscription.**

Parameters

Name Type Description Notes
CreateGroupRequest CreateGroupRequest

Return type

Group

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createGroupAnnouncement

GroupAnnouncement createGroupAnnouncement(groupId, CreateGroupAnnouncementRequest)

Create Group Announcement

Creates an Announcement for a Group. Warning: This will also remove all announcements. To make proper announcements, use the posts endpoint instead

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
CreateGroupAnnouncementRequest CreateGroupAnnouncementRequest

Return type

GroupAnnouncement

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createGroupGallery

GroupGallery createGroupGallery(groupId, CreateGroupGalleryRequest)

Create Group Gallery

Creates a gallery for a Group.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
CreateGroupGalleryRequest CreateGroupGalleryRequest

Return type

GroupGallery

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createGroupInvite

createGroupInvite(groupId, CreateGroupInviteRequest)

Invite User to Group

Sends an invite to a user to join the group.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
CreateGroupInviteRequest CreateGroupInviteRequest

Return type

null (empty response body)

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createGroupRole

GroupRole createGroupRole(groupId, CreateGroupRequest_1)

Create GroupRole

Create a Group role.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
CreateGroupRequest_1 CreateGroupRequest_1

Return type

GroupRole

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

declineGroupInvite

Success declineGroupInvite(groupId, DeclineGroupInviteRequest)

Decline Invite from Group

Declines an invite to the user from a group.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
DeclineGroupInviteRequest DeclineGroupInviteRequest [optional]

Return type

Success

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteGroup

Success deleteGroup(groupId, hardDelete)

Delete Group

Deletes a Group.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
hardDelete Boolean [optional] [default to null]

Return type

Success

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

deleteGroupAnnouncement

Success deleteGroupAnnouncement(groupId)

Delete Group Announcement

Deletes the announcement for a Group.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]

Return type

Success

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

deleteGroupGallery

Success deleteGroupGallery(groupId, groupGalleryId)

Delete Group Gallery

Deletes a gallery for a Group.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
groupGalleryId String Must be a valid group gallery ID. [default to null]

Return type

Success

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

deleteGroupGalleryImage

Success deleteGroupGalleryImage(groupId, groupGalleryId, groupGalleryImageId)

Delete Group Gallery Image

Deletes an image from a Group gallery.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
groupGalleryId String Must be a valid group gallery ID. [default to null]
groupGalleryImageId String Must be a valid group gallery image ID. [default to null]

Return type

Success

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

deleteGroupInvite

deleteGroupInvite(groupId, userId)

Delete User Invite

Deletes an Group invite sent to a User

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
userId String Must be a valid user ID. [default to null]

Return type

null (empty response body)

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

deleteGroupPost

Success deleteGroupPost(groupId, notificationId)

Delete a Group post

Delete a Group post

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
notificationId String Must be a valid notification ID. [default to null]

Return type

Success

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

deleteGroupRole

List deleteGroupRole(groupId, groupRoleId)

Delete Group Role

Deletes a Group Role by ID and returns the remaining roles.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
groupRoleId String Must be a valid group role ID. [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroup

Group getGroup(groupId, includeRoles)

Get Group by ID

Returns a single Group by ID.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
includeRoles Boolean Include roles for the Group object. Defaults to false. [optional] [default to null]

Return type

Group

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroupAnnouncements

GroupAnnouncement getGroupAnnouncements(groupId)

Get Group Announcement

Returns the announcement for a Group. If no announcement has been made, then it returns **empty object**. If an announcement exists, then it will always return all fields except `imageId` and `imageUrl` which may be null.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]

Return type

GroupAnnouncement

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroupAuditLogEntryTypes

List getGroupAuditLogEntryTypes(groupId)

Get Group Audit Log Entry Types

Returns a list of audit log entry types for which the group has entries.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroupAuditLogs

PaginatedGroupAuditLogEntryList getGroupAuditLogs(groupId, n, offset, startDate, endDate, actorIds, eventTypes, targetIds)

Get Group Audit Logs

Returns a list of audit logs for a Group.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
n Integer The number of objects to return. [optional] [default to 60]
offset Integer A zero-based offset from the default object sorting from where search results start. [optional] [default to null]
startDate Date The start date of the search range. [optional] [default to null]
endDate Date The end date of the search range. [optional] [default to null]
actorIds String The comma-separated actor ids to search for. [optional] [default to null]
eventTypes String The comma-separated event types to search for. [optional] [default to null]
targetIds String The comma-separated target ids to search for. [optional] [default to null]

Return type

PaginatedGroupAuditLogEntryList

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroupBans

List getGroupBans(groupId, n, offset)

Get Group Bans

Returns a list of banned users for a Group.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
n Integer The number of objects to return. [optional] [default to 60]
offset Integer A zero-based offset from the default object sorting from where search results start. [optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroupGalleryImages

List getGroupGalleryImages(groupId, groupGalleryId, n, offset, approved)

Get Group Gallery Images

Returns a list of images for a Group gallery.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
groupGalleryId String Must be a valid group gallery ID. [default to null]
n Integer The number of objects to return. [optional] [default to 60]
offset Integer A zero-based offset from the default object sorting from where search results start. [optional] [default to null]
approved Boolean If specified, only returns images that have been approved or not approved. [optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroupInstances

List getGroupInstances(groupId)

Get Group Instances

Returns a list of group instances

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroupInvites

List getGroupInvites(groupId, n, offset)

Get Group Invites Sent

Returns a list of members that have been invited to the Group.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
n Integer The number of objects to return. [optional] [default to 60]
offset Integer A zero-based offset from the default object sorting from where search results start. [optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroupMember

GroupMember getGroupMember(groupId, userId)

Get Group Member

Returns a GroupMember.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
userId String Must be a valid user ID. [default to null]

Return type

GroupMember

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroupMembers

List getGroupMembers(groupId, n, offset, sort, roleId)

List Group Members

Returns a List of all **other** Group Members. This endpoint will never return the user calling the endpoint. Information about the user calling the endpoint must be found in the `myMember` field of the Group object.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
n Integer The number of objects to return. [optional] [default to 60]
offset Integer A zero-based offset from the default object sorting from where search results start. [optional] [default to null]
sort String The sort order of Group Member results [optional] [default to null] [enum: joinedAt:asc, joinedAt:desc]
roleId String Only returns members with a specific groupRoleId [optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroupPermissions

List getGroupPermissions(groupId)

List Group Permissions

Returns a List of all possible/available permissions for a Group.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroupPosts

getGroupPosts_200_response getGroupPosts(groupId, n, offset, publicOnly)

Get posts from a Group

Get posts from a Group

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
n Integer The number of objects to return. [optional] [default to 60]
offset Integer A zero-based offset from the default object sorting from where search results start. [optional] [default to null]
publicOnly Boolean See public posts only. [optional] [default to null]

Return type

getGroupPosts_200_response

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroupRequests

List getGroupRequests(groupId, n, offset, blocked)

Get Group Join Requests

Returns a list of members that have requested to join the Group.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
n Integer The number of objects to return. [optional] [default to 60]
offset Integer A zero-based offset from the default object sorting from where search results start. [optional] [default to null]
blocked Boolean See blocked join requests [optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroupRoleTemplates

Map getGroupRoleTemplates()

Get Group Role Templates

Obtain predefined templates for group roles

Parameters

This endpoint does not need any parameter.

Return type

Map

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroupRoles

List getGroupRoles(groupId)

Get Group Roles

Returns a Group Role by ID.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroupTransferability

GroupTransferable getGroupTransferability(groupId, transferTargetId)

Get Group Transferability

Returns the transferability of the group to a given user.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
transferTargetId String The UserID of the prospective transferee. [optional] [default to null]

Return type

GroupTransferable

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

initiateOrAcceptGroupTransfer

Success initiateOrAcceptGroupTransfer(groupId, TransferGroupRequest)

Initiate or Accept Group Transfer

To initiate, must be logged in as the current owner and specify the transferTargetId in the body. To accept, must be logged in as the user targetted by a pending transfer, no body is required.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
TransferGroupRequest TransferGroupRequest [optional]

Return type

Success

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

joinGroup

GroupMember joinGroup(groupId, confirmOverrideBlock, JoinGroupRequest)

Join Group

Join a Group by ID and returns the member object.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
confirmOverrideBlock Boolean Manually override the failure that would occur if the user has blocked the group. [optional] [default to null]
JoinGroupRequest JoinGroupRequest [optional]

Return type

GroupMember

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

kickGroupMember

Success kickGroupMember(groupId, userId)

Kick Group Member

Kicks a Group Member from the Group. The current user must have the \"Remove Group Members\" permission. Also used for unblocking groups.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
userId String Must be a valid user ID. [default to null]

Return type

Success

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

leaveGroup

leaveGroup(groupId)

Leave Group

Leave a group by ID.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]

Return type

null (empty response body)

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

removeGroupMemberRole

List removeGroupMemberRole(groupId, userId, groupRoleId)

Remove Role from GroupMember

Removes a Role from a Group Member

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
userId String Must be a valid user ID. [default to null]
groupRoleId String Must be a valid group role ID. [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

respondGroupJoinRequest

respondGroupJoinRequest(groupId, userId, RespondGroupJoinRequest)

Respond Group Join request

Responds to a Group Join Request with Accept/Deny

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
userId String Must be a valid user ID. [default to null]
RespondGroupJoinRequest RespondGroupJoinRequest

Return type

null (empty response body)

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

searchGroupMembers

searchGroupMembers_200_response searchGroupMembers(groupId, query, n, offset)

Search Group Members

Search for members in the group by displayName.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
query String Filter for member displayName. [default to null]
n Integer The number of objects to return. [optional] [default to 60]
offset Integer A zero-based offset from the default object sorting from where search results start. [optional] [default to null]

Return type

searchGroupMembers_200_response

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

searchGroups

List searchGroups(query, offset, n)

Search Group

Searches Groups by name or shortCode

Parameters

Name Type Description Notes
query String Query to search for, can be either Group Name or Group shortCode [optional] [default to null]
offset Integer A zero-based offset from the default object sorting from where search results start. [optional] [default to null]
n Integer The number of objects to return. [optional] [default to 60]

Return type

List

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

unbanGroupMember

GroupMember unbanGroupMember(groupId, userId)

Unban Group Member

Unbans a user from a Group.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
userId String Must be a valid user ID. [default to null]

Return type

GroupMember

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

updateGroup

Group updateGroup(groupId, UpdateGroupRequest)

Update Group

Updates a Group and returns it.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
UpdateGroupRequest UpdateGroupRequest [optional]

Return type

Group

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateGroupGallery

GroupGallery updateGroupGallery(groupId, groupGalleryId, UpdateGroupGalleryRequest)

Update Group Gallery

Updates a gallery for a Group.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
groupGalleryId String Must be a valid group gallery ID. [default to null]
UpdateGroupGalleryRequest UpdateGroupGalleryRequest [optional]

Return type

GroupGallery

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateGroupMember

GroupMember updateGroupMember(groupId, userId, UpdateGroupMemberRequest)

Update Group Member

Updates a Group Member

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
userId String Must be a valid user ID. [default to null]
UpdateGroupMemberRequest UpdateGroupMemberRequest [optional]

Return type

GroupMember

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateGroupPost

GroupPost updateGroupPost(groupId, notificationId, CreateGroupPostRequest)

Edits a Group post

Edits a Group post

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
notificationId String Must be a valid notification ID. [default to null]
CreateGroupPostRequest CreateGroupPostRequest

Return type

GroupPost

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateGroupRepresentation

Success updateGroupRepresentation(groupId, updateGroupRepresentation_request)

Update Group Representation

Updates whether the user is representing the group.  When `isRepresenting` is set to `true`, this flag will be set to `false` for all other groups

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
updateGroupRepresentation_request updateGroupRepresentation_request

Return type

Success

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateGroupRole

List updateGroupRole(groupId, groupRoleId, UpdateGroupRoleRequest)

Update Group Role

Updates a group role by ID.

Parameters

Name Type Description Notes
groupId String Must be a valid group ID. [default to null]
groupRoleId String Must be a valid group role ID. [default to null]
UpdateGroupRoleRequest UpdateGroupRoleRequest [optional]

Return type

List

Authorization

authCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json
Reference in New Issue View Git Blame Copy Permalink