approve( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Approves a pending member using an ID, email address or approval token.

Tokens must be approved within 30 hours of token creation. Use the approvalToken parameter returned from the register() function when approving a member by token.

Note: 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.

Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Members
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsApproveOptions
Returns
Return Type:Promise<ApproveMemberResponse>
Was this helpful?
Yes
No