View Source VRChat.Groups (vrchat v1.11.1)

API calls for all endpoints tagged Groups.

Link to this section Summary

Functions

Add Group Gallery Image Adds an image to a Group gallery.

Add Role to GroupMember Adds a Role to a Group Member

Ban Group Member Bans a user from a Group.

Cancel Group Join Request Cancels a request sent to join the group.

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

Create Group Announcement Creates an Announcement for a Group.

Create Group Gallery Creates a gallery for a Group.

Invite User to Group Sends an invite to a user to join the group.

Create GroupRole Create a Group role.

Delete Group Deletes a Group.

Delete Group Announcement Deletes the announcement for a Group.

Delete Group Gallery Deletes a gallery for a Group.

Delete Group Gallery Image Deletes an image from a Group gallery.

Delete User Invite Deletes an Group invite sent to a User

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

Get Group by ID Returns a single Group by ID.

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.

Get Group Audit Logs Returns a list of audit logs for a Group.

Get Group Bans Returns a list of banned users for a Group.

Get Group Gallery Images Returns a list of images for a Group gallery.

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

Get Group Member Returns a LimitedGroup Member.

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.

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

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

Get Group Roles Returns a Group Role by ID.

Join Group Join a Group by ID and returns the member object.

Kick Group Member Kicks a Group Member from the Group. The current user must have the "Remove Group Members" permission.

Leave Group Leave a group by ID.

Remove Role from GroupMember Removes a Role from a Group Member

Respond Group Join request Responds to a Group Join Request with Accept/Deny

Unban Group Member Unbans a user from a Group.

Update Group Updates a Group and returns it.

Update Group Gallery Updates a gallery for a Group.

Update Group Member Updates a Group Member

Update Group Role Updates a group role by ID.

Link to this section Functions

Link to this function

add_group_member_role(connection, group_id, user_id, group_role_id, opts \\ [])

View Source
@spec add_group_member_role(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, [String.t()]} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}

Add Role to GroupMember Adds a Role to a Group Member

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • user_id (String.t): Must be a valid user ID.
  • group_role_id (String.t): Must be a valid group role ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, [%String{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

ban_group_member(connection, group_id, opts \\ [])

View Source
@spec ban_group_member(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.GroupMember.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Ban Group Member Bans a user from a Group.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters
    • :body (BanGroupMemberRequest):

returns

Returns

  • {:ok, VRChat.Model.GroupMember.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

cancel_group_request(connection, group_id, opts \\ [])

View Source
@spec cancel_group_request(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}

Cancel Group Join Request Cancels a request sent to join the group.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

create_group(connection, opts \\ [])

View Source
@spec create_group(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, VRChat.Model.Group.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

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

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :body (CreateGroupRequest):

returns

Returns

  • {:ok, VRChat.Model.Group.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

create_group_announcement(connection, group_id, opts \\ [])

View Source
@spec create_group_announcement(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Error.t()}
  | {:ok, VRChat.Model.GroupAnnouncement.t()}
  | {:error, Tesla.Env.t()}

Create Group Announcement Creates an Announcement for a Group.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters
    • :body (CreateGroupAnnouncementRequest):

returns

Returns

  • {:ok, VRChat.Model.GroupAnnouncement.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

create_group_gallery(connection, group_id, opts \\ [])

View Source
@spec create_group_gallery(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.GroupGallery.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Create Group Gallery Creates a gallery for a Group.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters
    • :body (CreateGroupGalleryRequest):

returns

Returns

  • {:ok, VRChat.Model.GroupGallery.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

create_group_invite(connection, group_id, opts \\ [])

View Source
@spec create_group_invite(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}

Invite User to Group Sends an invite to a user to join the group.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters
    • :body (CreateGroupInviteRequest):

returns

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

create_group_role(connection, group_id, opts \\ [])

View Source
@spec create_group_role(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.GroupRole.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Create GroupRole Create a Group role.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters
    • :body (CreateGroupRoleRequest):

returns

Returns

  • {:ok, VRChat.Model.GroupRole.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

delete_group(connection, group_id, opts \\ [])

View Source
@spec delete_group(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Success.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Delete Group Deletes a Group.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, VRChat.Model.Success.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

delete_group_announcement(connection, group_id, opts \\ [])

View Source
@spec delete_group_announcement(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Success.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Delete Group Announcement Deletes the announcement for a Group.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, VRChat.Model.Success.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

delete_group_gallery(connection, group_id, group_gallery_id, opts \\ [])

View Source
@spec delete_group_gallery(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Success.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Delete Group Gallery Deletes a gallery for a Group.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • group_gallery_id (String.t): Must be a valid group gallery ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, VRChat.Model.Success.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

delete_group_invite(connection, group_id, user_id, opts \\ [])

View Source
@spec delete_group_invite(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}

Delete User Invite Deletes an Group invite sent to a User

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • user_id (String.t): Must be a valid user ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

delete_group_role(connection, group_id, group_role_id, opts \\ [])

View Source
@spec delete_group_role(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Error.t()}
  | {:ok, [VRChat.Model.GroupRole.t()]}
  | {:error, Tesla.Env.t()}

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

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • group_role_id (String.t): Must be a valid group role ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, [%GroupRole{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_group(connection, group_id, opts \\ [])

View Source
@spec get_group(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Group.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Get Group by ID Returns a single Group by ID.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters
    • :includeRoles (boolean()): Include roles for the Group object. Defaults to false.

returns

Returns

  • {:ok, VRChat.Model.Group.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_group_announcements(connection, group_id, opts \\ [])

View Source
@spec get_group_announcements(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Error.t()}
  | {:ok, VRChat.Model.GroupAnnouncement.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, VRChat.Model.GroupAnnouncement.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_group_audit_logs(connection, group_id, opts \\ [])

View Source
@spec get_group_audit_logs(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.PaginatedGroupAuditLogEntryList.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Get Group Audit Logs Returns a list of audit logs for a Group.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters
    • :n (integer()): The number of objects to return.
    • :offset (integer()): A zero-based offset from the default object sorting from where search results start.
    • :startDate (DateTime.t): The start date of the search range.
    • :endDate (DateTime.t): The end date of the search range.

returns

Returns

  • {:ok, VRChat.Model.PaginatedGroupAuditLogEntryList.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_group_bans(connection, group_id, opts \\ [])

View Source
@spec get_group_bans(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [VRChat.Model.GroupMember.t()]}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Get Group Bans Returns a list of banned users for a Group.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters
    • :n (integer()): The number of objects to return.
    • :offset (integer()): A zero-based offset from the default object sorting from where search results start.

returns

Returns

  • {:ok, [%GroupMember{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_group_invites(connection, group_id, opts \\ [])

View Source
@spec get_group_invites(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [VRChat.Model.GroupMember.t()]}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

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

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, [%GroupMember{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_group_member(connection, group_id, user_id, opts \\ [])

View Source
@spec get_group_member(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Error.t()}
  | {:ok, VRChat.Model.GroupLimitedMember.t()}
  | {:error, Tesla.Env.t()}

Get Group Member Returns a LimitedGroup Member.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • user_id (String.t): Must be a valid user ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, VRChat.Model.GroupLimitedMember.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_group_members(connection, group_id, opts \\ [])

View Source
@spec get_group_members(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [VRChat.Model.GroupMember.t()]}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters
    • :n (integer()): The number of objects to return.
    • :offset (integer()): A zero-based offset from the default object sorting from where search results start.

returns

Returns

  • {:ok, [%GroupMember{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_group_permissions(connection, group_id, opts \\ [])

View Source
@spec get_group_permissions(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [VRChat.Model.GroupPermission.t()]}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

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

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, [%GroupPermission{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_group_requests(connection, group_id, opts \\ [])

View Source
@spec get_group_requests(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [VRChat.Model.GroupMember.t()]}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

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

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, [%GroupMember{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_group_roles(connection, group_id, opts \\ [])

View Source
@spec get_group_roles(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Error.t()}
  | {:ok, [VRChat.Model.GroupRole.t()]}
  | {:error, Tesla.Env.t()}

Get Group Roles Returns a Group Role by ID.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, [%GroupRole{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

join_group(connection, group_id, opts \\ [])

View Source
@spec join_group(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.GroupMember.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Join Group Join a Group by ID and returns the member object.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, VRChat.Model.GroupMember.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

kick_group_member(connection, group_id, user_id, opts \\ [])

View Source
@spec kick_group_member(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}

Kick Group Member Kicks a Group Member from the Group. The current user must have the "Remove Group Members" permission.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • user_id (String.t): Must be a valid user ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

leave_group(connection, group_id, opts \\ [])

View Source
@spec leave_group(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}

Leave Group Leave a group by ID.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

remove_group_member_role(connection, group_id, user_id, group_role_id, opts \\ [])

View Source
@spec remove_group_member_role(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, [String.t()]} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}

Remove Role from GroupMember Removes a Role from a Group Member

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • user_id (String.t): Must be a valid user ID.
  • group_role_id (String.t): Must be a valid group role ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, [%String{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

respond_group_join_request(connection, group_id, user_id, opts \\ [])

View Source
@spec respond_group_join_request(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, nil} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}

Respond Group Join request Responds to a Group Join Request with Accept/Deny

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • user_id (String.t): Must be a valid user ID.
  • opts (keyword): Optional parameters
    • :body (RespondGroupJoinRequest):

returns

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

unban_group_member(connection, group_id, user_id, opts \\ [])

View Source
@spec unban_group_member(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, VRChat.Model.GroupMember.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Unban Group Member Unbans a user from a Group.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • user_id (String.t): Must be a valid user ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, VRChat.Model.GroupMember.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

update_group(connection, group_id, opts \\ [])

View Source
@spec update_group(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Group.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Update Group Updates a Group and returns it.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • opts (keyword): Optional parameters
    • :body (UpdateGroupRequest):

returns

Returns

  • {:ok, VRChat.Model.Group.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

update_group_gallery(connection, group_id, group_gallery_id, opts \\ [])

View Source
@spec update_group_gallery(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, VRChat.Model.GroupGallery.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Update Group Gallery Updates a gallery for a Group.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • group_gallery_id (String.t): Must be a valid group gallery ID.
  • opts (keyword): Optional parameters
    • :body (UpdateGroupGalleryRequest):

returns

Returns

  • {:ok, VRChat.Model.GroupGallery.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

update_group_member(connection, group_id, user_id, opts \\ [])

View Source
@spec update_group_member(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Error.t()}
  | {:ok, VRChat.Model.GroupLimitedMember.t()}
  | {:error, Tesla.Env.t()}

Update Group Member Updates a Group Member

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • user_id (String.t): Must be a valid user ID.
  • opts (keyword): Optional parameters
    • :body (UpdateGroupMemberRequest):

returns

Returns

  • {:ok, VRChat.Model.GroupLimitedMember.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

update_group_role(connection, group_id, group_role_id, opts \\ [])

View Source
@spec update_group_role(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Error.t()}
  | {:ok, [VRChat.Model.GroupRole.t()]}
  | {:error, Tesla.Env.t()}

Update Group Role Updates a group role by ID.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • group_id (String.t): Must be a valid group ID.
  • group_role_id (String.t): Must be a valid group role ID.
  • opts (keyword): Optional parameters
    • :body (UpdateGroupRoleRequest):

returns

Returns

  • {:ok, [%GroupRole{}, ...]} on success
  • {:error, Tesla.Env.t} on failure