deleteGroup( )

Hides a group from the Groups List or cancels a group request.

Notes:

  • Only group admins can delete their group.
  • The group will no longer be visible in the live site or the dashboard.
  • It is not possible to restore a deleted group with the Update Group method.
  • It is still possible to retrieve the group with the Get Group, List Groups, and Query Groups methods.
Method Declaration
Copy
function deleteGroup(groupId: string): Promise<DeleteGroupResponse>;
Method Parameters
groupIdstringRequired

ID of the group to delete.

Returns
Return Type:Promise<DeleteGroupResponse>
JavaScript
import { groups } from "wix-groups.v2";

async function deleteGroup(groupId) {
  try {
    const result = await groups.deleteGroup(groupId);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}
Errors

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

Did this help?