# Introduction

With the Member Privacy Settings API you can override the [default privacy status](fallback::https://dev.wix.com/docs/sdk/backend-modules/members/default-privacy/introduction) of site members' profiles. For example, if the default status is private, you can switch the privacy settings to public, so that users could have an ability to make the profiles public. Use this API to quickly switch the privacy settings for all site members at once.

With the Member Privacy Settings API, you can:

- [Set](fallback::https://dev.wix.com/docs/sdk/backend-modules/members/default-privacy/set-default-privacy-status) the member privacy settings.
- [Retrieve](fallback::https://dev.wix.com/docs/sdk/backend-modules/members/default-privacy/get-default-privacy-status) the member privacy settings.

## Overriding the default privacy status

If you call the Member Privacy Settings API, new settings are applied for the current members of the site, overriding the default status. For newly signed up members, only the default status is applied.

- Example for using the [Default Privacy Status](fallback::https://dev.wix.com/docs/sdk/backend-modules/members/default-privacy/introduction) API together with the Member Privacy Settings API when the site's default privacy status is `PRIVATE`:
    - Call [Set Member Privacy Settings](fallback::https://dev.wix.com/docs/sdk/backend-modules/members/member-privacy-settings/set-member-privacy-settings) to update the privacy settings to `PUBLIC`. Current members can now choose to make their profiles `PUBLIC`. Newly signed-up members will have private profiles by default but can change their profiles to `PUBLIC` individually.

- Example for using the [Default Privacy Status](fallback::https://dev.wix.com/docs/sdk/backend-modules/members/default-privacy/introduction) together with the Member Privacy Settings API when the site's default privacy status is `PUBLIC`:
    - Call [Set Member Privacy Settings](fallback::https://dev.wix.com/docs/sdk/backend-modules/members/member-privacy-settings/set-member-privacy-settings) to update the privacy settings to `PRIVATE`. All current and newly signed-up members can't make the profile `PUBLIC`.

## Terminology

- **Member privacy settings:** Settings that determine who can see site members' profiles and who is allowed to make member profiles public.

@package_metadata:@wix/members

To use the MemberPrivacySettings API, install the `@wix/members` package.

#### Install the package

Follow the installation instructions for your development environment.

| Development environment | Installation method |
|--|--|
| Wix sites (editor or IDE) | Use the [package manager](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor). |
| Wix sites (local IDE) | Run `wix install @wix/members` using the [Wix CLI](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli).|
| Blocks apps | Use the same installation method as Wix sites. |
| CLI and self-hosted apps | Run `npm install @wix/members` or `yarn add @wix/members`. |
| Headless sites and apps | Run `npm install @wix/members` or `yarn add @wix/members`. |

#### Import the package

To import the package in your code:

```js
import { memberPrivacySettings } from '@wix/members'
```

Coding Examples

Sled Tests

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

API Reference

Velo

Picasso

GraphQL (Alpha)

MemberPrivacySettings

Member Privacy Settings 1 0 0

Retrieves the member privacy settings for a site.

If no settings were set, the default settings are retrieved.

>**Note:**
>This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).

import { memberPrivacySettings } from '@wix/members';

async function getMemberPrivacySettings() {
  const response = await memberPrivacySettings.getMemberPrivacySettings();
};

getMemberPrivacySettings

import { memberPrivacySettings } from '@wix/members';
import { auth } from '@wix/essentials';

async function myGetMemberPrivacySettingsMethod() {
  const elevatedGetMemberPrivacySettings = auth.elevate(memberPrivacySettings.getMemberPrivacySettings);
  const response = await elevatedGetMemberPrivacySettings();
}

getMemberPrivacySettings (with elevated permissions)

import { createClient } from '@wix/sdk';
import { memberPrivacySettings } from '@wix/members';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { memberPrivacySettings },
  // Include the auth strategy and host as relevant
});


async function getMemberPrivacySettings() {
  const response = await myWixClient.memberPrivacySettings.getMemberPrivacySettings();
};

Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).

getMemberPrivacySettings (self-hosted)

GetMemberPrivacySettingsResponse

memberPrivacySettings

Sets the member privacy settings for a site.

Each time the member privacy settings are updated, `revision` increments by 1. The existing `revision` must be included when updating the member privacy settings. This ensures you're working with the latest member privacy settings and prevents unintended overwrites.

import { memberPrivacySettings } from '@wix/members';

async function setMemberPrivacySettings(memberPrivacySettings) {
  const response = await memberPrivacySettings.setMemberPrivacySettings(memberPrivacySettings);
};

setMemberPrivacySettings

import { memberPrivacySettings } from '@wix/members';
import { auth } from '@wix/essentials';

async function mySetMemberPrivacySettingsMethod(memberPrivacySettings) {
  const elevatedSetMemberPrivacySettings = auth.elevate(memberPrivacySettings.setMemberPrivacySettings);
  const response = await elevatedSetMemberPrivacySettings(memberPrivacySettings);
}

setMemberPrivacySettings (with elevated permissions)

import { createClient } from '@wix/sdk';
import { memberPrivacySettings } from '@wix/members';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { memberPrivacySettings },
  // Include the auth strategy and host as relevant
});


async function setMemberPrivacySettings(memberPrivacySettings) {
  const response = await myWixClient.memberPrivacySettings.setMemberPrivacySettings(memberPrivacySettings);
};

setMemberPrivacySettings (self-hosted)

SetMemberPrivacySettingsResponse

Thrown when provided with an incorrect `revision` value.

Thrown when provided with invalid settings.

# Introduction

With the Member Privacy Settings API you can override the [default privacy status](https://dev.wix.com/docs/sdk/backend-modules/members/default-privacy/introduction) of site members' profiles. For example, if the default status is private, you can switch the privacy settings to public, so that users could have an ability to make the profiles public. Use this API to quickly switch the privacy settings for all site members at once.

With the Member Privacy Settings API, you can:

- [Set](https://dev.wix.com/docs/sdk/backend-modules/members/default-privacy/set-default-privacy-status) the member privacy settings.
- [Retrieve](https://dev.wix.com/docs/sdk/backend-modules/members/default-privacy/get-default-privacy-status) the member privacy settings.

## Overriding the default privacy status

If you call the Member Privacy Settings API, new settings are applied for the current members of the site, overriding the default status. For newly signed up members, only the default status is applied.

- Example for using the [Default Privacy Status](https://dev.wix.com/docs/sdk/backend-modules/members/default-privacy/introduction) API together with the Member Privacy Settings API when the site's default privacy status is `PRIVATE`:
    - Call [Set Member Privacy Settings](https://dev.wix.com/docs/sdk/backend-modules/members/member-privacy-settings/set-member-privacy-settings) to update the privacy settings to `PUBLIC`. Current members can now choose to make their profiles `PUBLIC`. Newly signed-up members will have private profiles by default but can change their profiles to `PUBLIC` individually.

- Example for using the [Default Privacy Status](https://dev.wix.com/docs/sdk/backend-modules/members/default-privacy/introduction) together with the Member Privacy Settings API when the site's default privacy status is `PUBLIC`:
    - Call [Set Member Privacy Settings](https://dev.wix.com/docs/sdk/backend-modules/members/member-privacy-settings/set-member-privacy-settings) to update the privacy settings to `PRIVATE`. All current and newly signed-up members can't make the profile `PUBLIC`.

## Terminology

- **Member privacy settings:** Settings that determine who can see site members' profiles and who is allowed to make member profiles public.

@package_metadata:@wix/members

To use the MemberPrivacySettings API, install the `@wix/members` package.

#### Install the package

Follow the installation instructions for your development environment.

| Development environment | Installation method |
|--|--|
| Wix sites (editor or IDE) | Use the [package manager](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor). |
| Wix sites (local IDE) | Run `wix install @wix/members` using the [Wix CLI](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli).|
| Blocks apps | Use the same installation method as Wix sites. |
| CLI and self-hosted apps | Run `npm install @wix/members` or `yarn add @wix/members`. |
| Headless sites and apps | Run `npm install @wix/members` or `yarn add @wix/members`. |

#### Import the package

To import the package in your code:

```js
import { memberPrivacySettings } from '@wix/members'
```
  

members_member-privacy-settings

All members have private profiles with no option to make them public.

Unknown public member candidate. This value isn't used.

Candidates

string

Date and time when the member privacy settings were updated.

_updatedDate

publicMemberCandidates

publicMemberVisibility

Visibility

Revision number, which increments by 1 each time the member privacy settings are updated. To prevent conflicting changes, the existing revision must be used when updating member privacy settings.

revision

Unknown member visibility. This value isn't used.

All site visitors can see the members' profiles.

The members' profiles are only visible to logged-in site members.

getMemberPrivacySettings( )