updateGroup( )

Updates a group.

When a public or private group's name is updated, the slug is updated to reflect the new group name. Only group admins can update their group.

Notes:

  • When group.privacyStatus is updated from PRIVATE to PUBLIC, all pending group join requests are automatically approved.
  • When group.privacyStatus is updated from PRIVATE to SECRET, all pending group join requests are automatically rejected.
Method Declaration
Copy
function updateGroup(
  _id: string,
  group: UpdateGroup,
  options: UpdateGroupOptions,
): Promise<Group>;
Method Parameters
_idstringRequired

Group ID.

groupUpdateGroupRequired
optionsUpdateGroupOptions
Returns
Return Type:Promise<Group>
JavaScript
import { groups } from "@wix/groups";

async function updateGroup(id, group, options) {
  const response = await groups.updateGroup(id, group, options);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?