Search.../

deleteGroup( )

Deletes a group.

Description

The deleteGroup() function returns a Promise that resolves to the deleted group after it has successfully been deleted. Only site admins and group admins can delete their group. After the group is deleted, it is removed from both your site and the site's Dashboard.

Note: If the suppressAuth option is set to true, all permissions are overwritten, and all site members (including non-group members) can delete a group.

Syntax

function deleteGroup(groupId: string, [options: Options]): Promise<Group>

deleteGroup Parameters

NAME
TYPE
DESCRIPTION
groupId
string

ID of group to delete.

options
Optional
Options

Authorization options.

Returns

Return Type:

Promise<Group>
NAME
TYPE
DESCRIPTION
_id
string

Group ID.

name
string

Group name.

slug
string

Part of a group's URL, for example, 'https:/example.com/groups/{my-group-slug}'. Generally based on the group name, but for secret groups it is an autogenerated string of characters, for example, 'https:/example.com/groups/{5D3yTX}'. It is case-sensitive.

description
string

Group description.

privacyStatus
string

Group privacy level. One of:

  • PUBLIC: Site visitors can see the group and its content in the list of groups. Site members can join the group.
  • PRIVATE: Site visitors can see the group in the list of groups, but only group members can see its content. Site members can request to join the group.
  • SECRET: Only group members can see the group and its content in the list of groups. Site members can only join if invited by group admins, or other group members.
coverImage
CoverImage

Group cover image.

memberTitle
string

What group members are called. For example, 'Coworkers', 'Friends', or 'Students'.

memberCount
number

Number of members in the group.

settings
GroupSettings

Group settings.

lastActivityDate
Date

Date and time the group was last active. For example, a post or comment.

_createdDate
Date

Date and time the group was created.

_updatedDate
Date

Date and time the group was last updated.

owner
string

Site member ID of the group creator. Defaults to group creator.

Was this helpful?

Delete a group

Copy Code
1import { groups } from 'wix-groups-backend';
2
3// Sample groupId value:
4// 'fc3df3c1-36b2-4279-8be1-8e72a05a88c8'
5//
6// Sample options value:
7// {
8// suppressAuth: true
9// }
10
11export function myCreateGroupFunction(groupId, options) {
12 return groups.deleteGroup(groupId, options)
13 .then((deletedGroup) => {
14 return deletedGroup;
15 })
16 .catch((error) => {
17 console.error(error);
18 });
19}
20
21/* Promise resolves to:
22 * {
23 * "_id": "fc3df3c1-36b2-4279-8be1-8e72a05a88c8"
24 * "name": "My Group 1"
25 * "slug": "my-group-1"
26 * "description": "Welcome to the group! You can connect with other members, get updates and share videos."
27 * "privacyStatus": "PUBLIC"
28 * "coverImage": {
29 * "imageUrl": "wix:image://v1/3aa9074e348009011fa9f2d2981a~mv2.jpg/kite.jpg#originWidth=827&originHeight=445",
30 * "position": {
31 * "x": 160,
32 * "y": 13
33 * }
34 * }
35 * "memberTitle": "Members"
36 * "memberCount": 20
37 * "settings": {
38 * "groupUpdatePostEnabled": true
39 * "membersCanApprove": false
40 * "membersCanInvite": true
41 * "showMemberList": true
42 * "welcomeMemberPostEnabled": true
43 * }
44 * "lastActivityDate": "Sun Sep 26 2021 08:23:23 GMT+0300"
45 * "_createdDate": "Tues January 22 2020 12:56:02 GMT+0300"
46 * "_updatedDate": "Fri October 2 2021 04:56:22 GMT+0300"
47 * "owner": "9ne8e9e1-d050-4c86-9684-e7f231600a34"
48 * }
49 */