leaveCommunity( )

Removes the currently logged-in member from the site community and sets their profile to private.

When a member's profile is private, they do not have access to the site's Members Area features — such as chat, forum, and followers — and their profile is hidden from other members and site visitors.


  • If a member leaves the site's community, their content (such as forum posts and blog comments) remain publicly visible.
  • Only logged-in members can call this function without elevated permissions.
  • To call this function as a different identity, elevated permissions are required.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings Services and Settings
Learn more about permission scopes.
Method Declaration
This method does not take any parameters
Return Type:Promise<LeaveCommunityResponse>
Was this helpful?