updateGroup( )

Updates a group.

The updateGroup() function returns a Promise that resolves to the updated group. Only site admins and group admins can update their group. Only the fields in the groupInfo object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.

Notes:

  • If the suppressAuth option is set to true, all permissions are overwritten, and all site members (including non-group members) can update a group.
  • When a group's privacyStatus is updated from PRIVATE to PUBLIC, all pending join requests for that group are automatically approved.
  • When a group's privacyStatus is updated from PRIVATE to SECRET, all pending join requests for that group are automatically rejected.
  • When a public or private group's name is updated, the slug is updated to reflect the new group name.
Method Declaration
Copy
Method Parameters
groupIdstringRequired

ID of group to update.

groupInfoGroupInfoUpdateRequired

Group information to update.

optionsOptions

Authorization options.

Returns
Return Type:Promise<Group>
Did this help?