rejectGroupRequests( )

Developer Preview

Rejects a request to create a group.

Description

The rejectGroupRequests() function returns a Promise that resolves when a member's request to create a group is rejected. Only site admins can reject requests to create a group.

Note: This function is only relevant if admin approval is required for creating a group.

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function rejectGroupRequests(rejections: Array<Rejection>): Promise<RejectGroupRequestsResponse>

rejectGroupRequests Parameters

NAME

TYPE

DESCRIPTION

rejections

Array<

Rejection

Rejection data.

Returns

Return Type:

Promise<

RejectGroupRequestsResponse

NAME

TYPE

DESCRIPTION

groupRequest

Array<

GroupRequest

Rejected Group Requests.

Was this helpful?

Reject a request to create a group

Copy Code

1import { createRequests } from 'wix-groups.v2';
2
3// Sample rejections value:
4// [
5//  {
6//    groupRequestId: '77490611-53bb-4b47-a7cc-ca9a1335133b',
7//    reason: 'This group is for teachers only'
8//  }
9// ]
10//
11
12export function myRejectGroupRequestsFunction(rejections) {
13  return createRequests.rejectGroupRequests(rejections)
14    .then((rejectedGroupRequests) => {
15      return rejectedGroupRequests;
16    })
17    .catch((error) => {
18      console.error(error);
19    });
20}
21
22/* Promise resolves to:
23 * {
24 *   "groupRequest": [ 
25 *     {
26 *       "_id": "77490611-53bb-4b47-a7cc-ca9a1335133b",
27 *       "status": "REJECTED",
28 *       "rejectionReason": "This group is for teachers only.", 
29 *       "group": {
30 *         "_id": "77490611-53bb-4b47-a7cc-ca9a1335133b",
31 *         "name": "My Group Request 5",
32 *         "slug": "my-group-request-5",
33 *         "description": "Welcome to the group! You can connect with other members, get updates and share videos.",
34 *         "privacyStatus": "PRIVATE",
35 *         "coverImage": {
36 *           "imageUrl": "wix:image://v1/jb9074e348009011fa9f2dzj0jn~mv2.jpg/nutmeg.jpg#originWidth=800&originHeight=720",
37 *           "position": {
38 *             "x": 66,
39 *             "y": 10
40 *           }
41 *         },
42 *         "memberTitle": "Co-workers",
43 *         "memberCount": 1,
44 *         "settings": {
45 *           "groupUpdatePostEnabled": true,
46 *           "membersCanApprove": false,
47 *           "membersCanInvite": true,
48 *           "showMemberList": true,
49 *           "welcomeMemberPostEnabled": true
50 *         },
51 *         "lastActivityDate": "Sun Sep 26 2021 08:23:23 GMT+0300",
52 *         "_createdDate": "Sun Sep 26 2021 08:23:23 GMT+0300",
53 *         "_updatedDate": "Sun Sep 26 2021 08:23:23 GMT+0300",
54 *         "owner": "9ne8e9e1-d050-4c86-9684-e7f231600a34"
55 *       }
56 *     }
57 *   ]
58 * }
59 */