approveByEmail( )

Approves a pending member using an email address.

Description

The approveByEmail() function returns a Promise that resolves to a session token when the specified member is approved.

Note: This function replaces the deprecated wix-users-backend.approveByEmail(). The deprecated function will continue to work, but it will not receive updates. To keep any existing code compatible with future changes, see the migration instructions.

A new member's status is "PENDING" when the site's membership policy is set to manual approval. To learn more about setting your site's membership approval policy, see Editing Your Member Signup Settings.

Syntax

function approveByEmail(email: string): Promise<string>

approveByEmail Parameters

NAME

TYPE

DESCRIPTION

string

Returns

Fulfilled - Session token, which can be applied using the wix-members-frontend applySessionToken() function to log the member in. Rejected - Error message.

Return Type:

Promise<string>

Approve a pending member using an email address

This example contains a backend function that approves a pending member using their email address. It returns a session token to be used in page code to log in the member who was just approved.

Copy Code

1import { authentication } from 'wix-members-backend';
2
3export function myApproveByEmailFunction(email) {
4
5  return authentication.approveByEmail(email)
6    .then((sessionToken) => {
7      return {
8        sessionToken: sessionToken,
9        approved: true
10      };
11    })
12    .catch((error) => {
13      return {
14        approved: false,
15        reason: error
16      };
17    });
18}
19
20/* Promise resolves to:
21 * "JWS.eyJraWQiOiJQSXpvZGJiQiIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiaWRcIjpcImViNDNhYjk5LTMwNDAtNGNhMC04OTNkLTNjNWZhMzdjNjNhZFwiLFwiY29sbGVjdGlvbklkXCI6XCI5YmVjNThlNi02NDExLTQ5OTEtOGU1ZC0wYWRhOTE4MmI5NWVcIixcIm1ldGFTaXRlSWRcIjpcIjFmZjQ2YTk2LWRlYTYtNDlkYS04M2JhLTUxNjRmYjYyZDgzOVwiLFwib3duZXJcIjpmYWxzZSxcImNyZWF0aW9uVGltZVwiOjE2MjgxMTcwNjU5NDcsXCJleHBpcmVzSW5cIjoxMjA5NjAwMDAwLFwiZXhwaXJhdGlvblRpbWVcIjoxNjI4MTE3MTg1OTQ3LFwibGFzdFJlZnJlc2hlZFwiOjAsXCJhZG1pblwiOmZhbHNlfSIsImlhdCI6MTYyODExNzA2NX0.VGNW1Q26zD8BmSvlljFlP6-OhvYs_Pa2hQidS2tt9No"
22 */