Rejects requests to join a group.
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
.
function rejectJoinGroupRequests(
groupId: string,
rejections: Array<Rejection>,
options: RejectJoinGroupRequestsOptions,
): Promise<RejectJoinGroupRequestsResponse>;
ID of the group requested to join.
Rejection data.
import { joinGroupRequests } from "wix-groups.v2";
// Sample groupId: "6z2334b13bb4b44569a7cdf292j227"
//
// Sample rejections value:
// [
// {
// memberId: '77490611-53bb-4b47-a7cc-ca9a1335133b',
// reason: 'This group is for college students only.'
// }
// ]
async function rejectJoinGroupRequests(groupId, rejections, options) {
try {
const result = await joinGroupRequests.rejectJoinGroupRequests(
groupId,
rejections,
);
return result;
} catch (error) {
console.error(error);
// Handle the error
}
}
/* Promise resolves to:
* joinGroupRequests: [
* {
* "requestDetails": {"rejectionReason": "This group is for college students only."}
* "siteMemberId": "124cd3db-e9be-4980-93c1-a6d767a11099"
* "status": "REJECTED"
* }
* ]
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.