rejectJoinGroupRequests( )

Rejects requests to join a group.

Description

Note: This function is only relevant for private groups.

The rejectjoinGroupRequests() function returns a Promise that resolves when the site member's request to join a group is rejected. Only site admins or group admins can reject site member requests to join the group, unless the group setting, membersCanApprove is set to true.

Admin Method

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

Syntax

function rejectJoinGroupRequests(groupId: string, rejections: Array<Rejection>): Promise<RejectJoinGroupRequestsResponse>

rejectJoinGroupRequests Parameters

NAME

TYPE

DESCRIPTION

groupId

string

ID of the group requested to join.

rejections

Array<

Rejection

Rejection data.

Returns

Return Type:

Promise<

RejectJoinGroupRequestsResponse

NAME

TYPE

DESCRIPTION

joinGroupRequests

Array<

JoinGroupRequest

Rejected join group requests.

Was this helpful?

Reject a request to join a group (dashboard page code)

Copy Code

1import { joinGroupRequests } from 'wix-groups.v2';
2  
3// Sample groupId: "6z2334b13bb4b44569a7cdf292j227"
4//
5// Sample rejections value:
6// [
7//  {
8//    memberId: '77490611-53bb-4b47-a7cc-ca9a1335133b',
9//    reason: 'This group is for college students only.'
10//  }
11// ]
12
13 async function rejectJoinGroupRequests(groupId, rejections, options) {
14   try {
15     const result = await joinGroupRequests.rejectJoinGroupRequests(groupId, rejections);
16
17     return result;
18   } catch (error) {
19     console.error(error);
20     // Handle the error
21   }
22 }
23
24 /* Promise resolves to:
25 *  joinGroupRequests: [
26 *    { 
27 *      "requestDetails": {"rejectionReason": "This group is for college students only."}
28 *      "siteMemberId": "124cd3db-e9be-4980-93c1-a6d767a11099"
29 *      "status": "REJECTED"
30 *    }
31 *  ]  
32 */

Reject a request to join a group (export from backend code)

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { joinGroupRequests } from 'wix-groups.v2';
3  
4/* Sample groupId: "6z2334b13bb4b44569a7cdf292j227"
5 *
6 * Sample rejections value:
7 * [
8 *  {
9 *    memberId: '77490611-53bb-4b47-a7cc-ca9a1335133b',
10 *    reason: 'This group is for college students only.'
11 *  }
12 * ]
13 */
14
15export const rejectJoinGroupRequests = webMethod(Permissions.Anyone, async (groupId, rejections, options) => {
16   try {
17     const result = await joinGroupRequests.rejectJoinGroupRequests(groupId, rejections);
18
19     return result;
20   } catch (error) {
21     console.error(error);
22     // Handle the error
23   }
24 });
25
26 /* Promise resolves to:
27  *  joinGroupRequests: [
28  *    { 
29  *      "requestDetails": {"rejectionReason": "This group is for college students only."}
30  *      "siteMemberId": "124cd3db-e9be-4980-93c1-a6d767a11099"
31  *      "status": "REJECTED"
32  *    }
33  *  ]  
34  */
35