{"id":"9cb58c28-0553-4c74-9236-191be40e577d","createdDate":"2025-07-22T05:10:41.032Z","updatedDate":"2025-07-22T05:10:41.032Z","resourceId":"97ab0efe-829f-49ca-9f8d-d4cea45ff4e1","sdk":{"schema":{"name":"velo_wix-members-frontend","fqn":"","slug":"velo-wix-members-frontend","typesMap":{"Authentication.LoginHandler":{"name":"LoginHandler","fqn":"Authentication.LoginHandler","slug":"login-handler","actions":[],"properties":[{"name":"currentMember","slug":"current-member","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CurrentMember","referenceFqn":"CurrentMember.CurrentMember"},"description":"Logged-in member."}],"returnType":{"kind":"PRIMITIVE","name":"void"}},"CurrentMember.CurrentMember":{"name":"CurrentMember","fqn":"CurrentMember.CurrentMember","slug":"current-member","actions":[{"name":"getMember","fqn":"CurrentMember.CurrentMember.getMember","slug":"get-member","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Member","referenceFqn":"CurrentMember.Member"},"description":"Fulfilled - If a member is logged in, the retrieved member.\r\nIf a member isn't logged in, `undefined`."},"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FieldsetOptions","referenceFqn":"CurrentMember.FieldsetOptions"},"description":"Fieldset options."}],"description":"Retrieves the currently logged-in member.\r\n\r\n`getMember()` returns a Promise that resolves\r\nto the currently logged-in member, or `undefined` if a member isn't logged in.\r\n\r\n> **Notes:**\r\n> - The member data in the resolved promise will only include custom fields from a site's contacts if those [fields are added to a site's members in a dashboard](https://support.wix.com/en/article/site-members-customizing-your-member-profile-fields).\r\n> - The frontend Members APIs aren't fully functional when previewing a site. View a published version of a site to see their complete functionality.","sdkErrors":[],"kind":"GENERAL"},{"name":"getRoles","fqn":"CurrentMember.CurrentMember.getRoles","slug":"get-roles","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Role","referenceFqn":"CurrentMember.Role"}},"description":"Fulfilled - List of roles.\r\nRejected - If no member is currently logged in."},"description":"Retrieves the member's roles.\r\n\r\n`getRoles()` returns a Promise that resolves to the\r\n[roles](https://support.wix.com/en/article/site-members-creating-member-roles)\r\nof the currently logged-in member.\r\nIf no member is currently logged in, the Promise is rejected.\r\n\r\n> **Notes:**\r\n> - The member data in the resolved promise will only include custom fields from a site's contacts if those [fields are added to a site's members in a dashboard](https://support.wix.com/en/article/site-members-customizing-your-member-profile-fields).\r\n> - The frontend Members APIs aren't fully functional when previewing a site. View a published version of a site to see their complete functionality.\r\n\r\nThe following results are returned depending on the session identity:\r\n\r\n| Session Identity | Promise Resolves To |\r\n| ------------------------------------------------ | ---------------------------------------------------------------------- |\r\n| Logged-in member | Array of member roles |\r\n| Site owner or contributor with admin permissions | Array of member roles, plus an additional role where `name` is `Admin` |\r\n| Anyone else | Promise is rejected |","sdkErrors":[],"kind":"GENERAL"},{"name":"makeProfilePrivate","fqn":"CurrentMember.CurrentMember.makeProfilePrivate","slug":"make-profile-private","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Member","referenceFqn":"CurrentMember.Member"},"description":"Fulfilled - Updated member."},"description":"Removes the currently logged-in member from the site community and sets their profile to private.\r\n\r\n`makeProfilePrivate()` returns a Promise that resolves to a member object\r\nwhen the member's profile privacy is updated.\r\n\r\nWhen a member's profile is private,\r\nthey don't have access to the site's\r\n[Members Area](https://support.wix.com/en/article/site-members-about-the-members-area)\r\nfeatures, and their profile is hidden from other members and site visitors.\r\n\r\n> **Notes:**\r\n> - The member data in the resolved promise will only include custom fields from a site's contacts if those [fields are added to a site's members in a dashboard](https://support.wix.com/en/article/site-members-customizing-your-member-profile-fields).\r\n> - The frontend Members APIs aren't fully functional when previewing a site. View a published version of a site to see their complete functionality.\r\n> - If a public member profile changes to private, their public content (such as forum posts and blog comments) remain publicly visible.","sdkErrors":[],"kind":"GENERAL"},{"name":"makeProfilePublic","fqn":"CurrentMember.CurrentMember.makeProfilePublic","slug":"make-profile-public","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"description":"Joins the currently logged-in member to the site community and sets their profile to public.\r\n\r\n`makeProfilePublic()` returns a Promise that resolves to a member object\r\nwhen the member's profile privacy is updated.\r\n\r\nWhen a member's profile is public,\r\nthey have access to the site's\r\n[Members Area](https://support.wix.com/en/article/site-members-about-the-members-area)\r\nfeatures, such as chat, forum, and followers.\r\nAlso, their profile is visible to other members and site visitors.\r\n> **Notes:**\r\n> - The member data in the resolved promise will only include custom fields from a site's contacts if those [fields are added to a site's members in a dashboard](https://support.wix.com/en/article/site-members-customizing-your-member-profile-fields).\r\n> - The frontend Members APIs aren't fully functional when previewing a site. View a published version of a site to see their complete functionality.","sdkErrors":[],"kind":"GENERAL"}],"properties":[]},"CurrentMember.FieldsetOptions":{"name":"FieldsetOptions","fqn":"CurrentMember.FieldsetOptions","slug":"fieldset-options","actions":[],"properties":[{"name":"fieldsets","slug":"fieldsets","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Predefined sets of fields to return.\r\nWhen multiple fieldsets are provided, the union of all the included fields is returned.\r\n\r\nPredefined fieldsets are one of:\r\n\r\n- `\"FULL\"`: Returns all fields.\r\n- `\"PUBLIC\"`: Returns `_id` and all fields under `profile`. With this fieldset, `profile.status`, `profile.privacyStatus`, and `profile.activityStatus` are returned as `\"UNKNOWN\"`.\r\n\r\nDefaults to `[ \"FULL\" ]`."}]},"CurrentMember.Member":{"name":"Member","fqn":"CurrentMember.Member","slug":"member","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time when the member was created."},{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID."},{"name":"_updatedDate","slug":"updated-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time when the member was updated."},{"name":"activityStatus","slug":"activity-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member activity status.\r\n\r\n\r\n\r\n\r\nOne of:\r\n\r\n- `\"ACTIVE\"`: Member can write forum posts and blog comments.\r\n- `\"MUTED\"`: Member can't write forum posts or blog comments.\r\n- `\"UNKNOWN\"`: Insufficient permissions to get the status."},{"name":"contactDetails","slug":"contact-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactDetails","referenceFqn":"CurrentMember.ContactDetails"},"description":"Member's contact information. Contact information is stored in the\r\n[Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts)."},{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID."},{"name":"lastLoginDate","slug":"last-login-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time when the member last logged in to the site."},{"name":"loginEmail","slug":"login-email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Email used by the member to log in to the site."},{"name":"privacyStatus","slug":"privacy-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member privacy status.\r\n\r\n\r\n\r\n\r\nOne of:\r\n\r\n- `\"PUBLIC\"`: Member is visible to everyone.\r\n- `\"PRIVATE\"`: Member is hidden from site visitors and other site members. Member is returned only to Wix users and apps with the appropriate permissions.\r\n- `\"UNKNOWN\"`: Insufficient permissions to get the status."},{"name":"profile","slug":"profile","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Profile","referenceFqn":"CurrentMember.Profile"},"description":"Profile display info."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member site access status.\r\n\r\n\r\n\r\nOne of:\r\n\r\n- `\"PENDING\"`: Member created and is waiting for approval by a Wix user.\r\n- `\"APPROVED\"`: Member can log in to the site.\r\n- `\"OFFLINE\"`: Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-managed-writers-to-your-blog) for the site blog and can't log in to the site.\r\n- `\"BLOCKED\"`: Member is blocked and can't log in to the site.\r\n- `\"UNKNOWN\"`: Insufficient permissions to get the status."}]},"CurrentMember.ContactDetails":{"name":"ContactDetails","fqn":"CurrentMember.ContactDetails","slug":"contact-details","actions":[],"properties":[{"name":"addresses","slug":"addresses","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Address","referenceFqn":"CurrentMember.Address"}},"description":"List of street addresses."},{"name":"birthdate","slug":"birthdate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's birthdate, formatted as `\"YYYY-MM-DD\"`.\r\n\r\n For example, `\"2025-03-15\"` for March 15, 2025."},{"name":"company","slug":"company","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's company name."},{"name":"customFields","slug":"custom-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"Custom fields, structured as `key:object` pairs.\r\n\r\nCustom field IDs are defined in the \r\nExtended Fields API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/extended-fields/introduction) | [Velo](https://dev.wix.com/docs/velo/apis/wix-crm-v2/extended-fields/introduction)).\r\nThe paired object contains the `name` and `value` properties,\r\nwhere `name` is the display name and `value` is the value stored for the member.\r\n\r\nOnly custom fields\r\n[added to the member profile in a dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmembers-account)\r\nare available through the Members API.\r\nEmpty fields aren't returned.\r\n\r\nWhen updating a member, `name` is ignored."},{"name":"emails","slug":"emails","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of email addresses."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's first name."},{"name":"jobTitle","slug":"job-title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's job title."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's last name."},{"name":"phones","slug":"phones","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of phone numbers."}]},"CurrentMember.Address":{"name":"Address","fqn":"CurrentMember.Address","slug":"address","actions":[],"oneofProperties":{"addressStreet":[{"name":"addressLine","slug":"address-line","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main address line, usually street and number, as free text."},{"name":"streetAddress","slug":"street-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StreetAddress","referenceFqn":"CurrentMember.StreetAddress"},"description":"Street address object, with number and name in separate fields."}]},"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street address ID."},{"name":"addressLine2","slug":"address-line2","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Free text providing more detailed address information,\r\n such as apartment, suite, or floor."},{"name":"city","slug":"city","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"City name."},{"name":"country","slug":"country","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"2-letter country code in an\r\n[ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format."},{"name":"postalCode","slug":"postal-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Postal code."},{"name":"subdivision","slug":"subdivision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Code for a subdivision (such as state, prefecture, or province) in an\r\n[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format."}]},"CurrentMember.StreetAddress":{"name":"StreetAddress","fqn":"CurrentMember.StreetAddress","slug":"street-address","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street name."},{"name":"number","slug":"number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street number."}]},"CurrentMember.Profile":{"name":"Profile","fqn":"CurrentMember.Profile","slug":"profile","actions":[],"properties":[{"name":"coverPhoto","slug":"cover-photo","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Image","referenceFqn":"CurrentMember.Image"},"description":"Member's profile photo."},{"name":"nickname","slug":"nickname","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name that identifies the member to other members.\r\nDisplayed on the member's profile page and interactions in the forum or blog."},{"name":"profilePhoto","slug":"profile-photo","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Image","referenceFqn":"CurrentMember.Image"},"description":"Member's profile photo."},{"name":"slug","slug":"slug","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Slug that determines the member's profile page URL."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member title."}]},"CurrentMember.Image":{"name":"Image","fqn":"CurrentMember.Image","slug":"image","actions":[],"properties":[{"name":"height","slug":"height","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Original image width."},{"name":"offsetX","slug":"offset-x","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"X-axis offset.\r\n\r\n Defaults to `0`."},{"name":"offsetY","slug":"offset-y","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Y-axis offset.\r\n\r\n Defaults to `0`."},{"name":"url","slug":"url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Image URL."},{"name":"width","slug":"width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Original image height."}]},"CurrentMember.Role":{"name":"Role","fqn":"CurrentMember.Role","slug":"role","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the role was created."},{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Role ID."},{"name":"color","slug":"color","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Role color, as defined in the site's\r\n[Member Permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmember-permissions/roles)\r\npage.\r\n\r\nOne of:\r\n\r\n- `\"DARK_BLUE\"`\r\n- `\"LIGHT_BLUE\"`\r\n- `\"TEAL\"`\r\n- `\"LIGHT_GREEN\"`\r\n- `\"YELLOW\"`\r\n- `\"ORANGE\"`\r\n- `\"RED\"`\r\n- `\"VIOLET\"`\r\n- `\"PURPLE\"`"},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Role description, if defined in the site's dashboard."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Role name as defined in the site's\r\n [Member Permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmember-permissions/roles)\r\n page or one of `\"Admin\"` or `\"Member\"`."}]},"Authentication.LogoutHandler":{"name":"LogoutHandler","fqn":"Authentication.LogoutHandler","slug":"logout-handler","actions":[],"properties":[],"returnType":{"kind":"PRIMITIVE","name":"void"}},"Authentication.LoginOptions":{"name":"LoginOptions","fqn":"Authentication.LoginOptions","slug":"login-options","actions":[],"properties":[{"name":"modal","slug":"modal","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the login form should be modal (`true`)\r\nor full screen (`false`).\r\n\r\nDefaults to `false` (full screen)."},{"name":"mode","slug":"mode","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Whether to display the `\"login\"` or `\"signup\"` prompt.\r\n\r\nDefaults to `\"signup\"`."}]},"Authentication.RegistrationOptions":{"name":"RegistrationOptions","fqn":"Authentication.RegistrationOptions","slug":"registration-options","actions":[],"properties":[{"name":"contactInfo","slug":"contact-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactInfo","referenceFqn":"Authentication.ContactInfo"},"description":"Contact information."},{"name":"privacyStatus","slug":"privacy-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Sets the [privacy status](https://support.wix.com/en/article/wix-groups-member-privacy-settings-for-groups) of a new member upon registration.\r\nOne of:\r\n\r\n - `\"PUBLIC\"`: Sets the new member status to public. A member whose status is public is a member of the site's community.\r\n - `\"PRIVATE\"`: Sets the new member status to private. A member whose status is private is not a member of the site's community.\r\n\r\nDefaults to `\"PRIVATE\"`."}]},"Authentication.ContactInfo":{"name":"ContactInfo","fqn":"Authentication.ContactInfo","slug":"contact-info","actions":[],"properties":[{"name":"customFields","slug":"custom-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"Any number of custom fields.\r\n\r\n Custom fields ([SDK](https://dev.wix.com/docs/sdk/frontend-modules/members/custom-fields) | [Velo](https://dev.wix.com/docs/velo/apis/wix-members-frontend/custom-fields))\r\n are used to store additional information about a site's contacts.\r\n\r\n >**Note:** `customFields` is not the name of a field in the `contactInfo` object. Here, it represents any custom fields that you've chosen to implement."},{"name":"emails","slug":"emails","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of contact's email addresses.\r\n When creating a contact, if no phone number is\r\n provided, at least 1 email address must be provided."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's first name."},{"name":"language","slug":"language","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's language."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's last name."},{"name":"phones","slug":"phones","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of contact's phone numbers.\r\n When creating a contact, if no email is\r\n provided, at least 1 phone number must be provided."},{"name":"picture","slug":"picture","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's image source URL."}]},"Authentication.RegistrationResult":{"name":"RegistrationResult","fqn":"Authentication.RegistrationResult","slug":"registration-result","actions":[],"properties":[{"name":"approvalToken","slug":"approval-token","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Token for approving the member\r\nwith [`approveByToken()`](https://dev.wix.com/docs/velo/apis/wix-members-backend/authentication/approve-by-token).\r\n`approvalToken` is safe to pass via email or from page code to backend code.\r\n\r\nReturned when `status` is `\"PENDING\"`."},{"name":"member","slug":"member","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Member","referenceFqn":"CurrentMember.Member"},"description":"The registered member.\r\n\r\nReturned when `status` is `\"ACTIVE\"`."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Registration status.\r\n\r\nOne of:\r\n\r\n- `\"PENDING\"`: The member must be approved before they can log in to the site.\r\n- `\"ACTIVE\"`: The member is approved and can log in to the site."}]},"Authentication.SetPasswordEmailOptions":{"name":"SetPasswordEmailOptions","fqn":"Authentication.SetPasswordEmailOptions","slug":"set-password-email-options","actions":[],"properties":[{"name":"hideIgnoreMessage","slug":"hide-ignore-message","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to hide the \"ignore this email\" message.\r\n\r\nIf `false`, the email tells the member\r\nthey can safely ignore if they didn't request the password change.\r\n\r\nDefault: `false`"}]}},"standaloneTypes":[],"metadata":{},"actions":[],"webhooks":[],"articles":[{"content":"# Introduction\nThe frontend Wix Members API allows you to manage member access to a site\nas well as view and manage the currently logged-in member.\n

\n Developer Preview\n
\n Some methods in this module are in Developer Preview. APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving these functions. Your feedback is valuable to us.\n

\n\nTo use the frontend Members API,\nimport the applicable named exports from `wix-members-frontend`:\n\n```js\nimport { authentication, currentMember } from 'wix-members-frontend';\n```","displayName":"Introduction","slugifyName":"introduction"},{"content":"# Custom fields\n\nMember profiles can contain custom data,\nlocated in the member object at `contactDetails.customFields`.\nThe member object is returned when calling these functions:\n\n- [`currentMember.getMember()`](https://dev.wix.com/docs/sdk/frontend-modules/members/current-member/get-member)\n- [`members.getMember()`](/members/get-member)\n- [`members.updateMember()`](/members/update-member)\n\nThe Members API works with [custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts) that are\n[added to the member profile in the Dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmembers-account).\nCustom fields that haven't been added to the member profile\naren't available through the Members API.\nWhen retrieving members, empty fields are not returned.\nYou can query, create, rename, and delete custom field definitions with the Contacts\n[Extended Fields API](https://dev.wix.com/docs/sdk/backend-modules/crm/extended-fields/introduction).\n\n## Data structure\n\nThe member's `customFields` object contains key:object pairs.\nThe key is defined in the Contacts Extended Fields API.\nThe paired object is structured as follows:\n\n```js\n{\n // ...\n customFields: {\n : {\n name: 'Field 1 Display Name',\n value: 'string' // Value stored for the member\n },\n : {\n name: 'Field 2 Display Name',\n value: 12345 // Value stored for the member\n }\n }\n}\n```\n\nThe paired object contains these properties:\n\n- `name`: Display name. Read only.\n- `value`: Value stored for the member.\n\n## Retrieve custom field IDs\n\nFor a list of your site's custom field IDs, use this function in your backend code:\n\n```js\nimport { contacts } from \"wix-crm-backend\";\n\nexport async function listCustomFieldKeys() {\n const queryResults = await contacts.queryExtendedFields().find();\n // Filters for custom fields (where fieldType is USER_DEFINED), then converts to an array of keys\n return queryResults.items\n .filter((field) => field.fieldType === \"USER_DEFINED\")\n .map((field) => field.key);\n}\n```\n\n## Set a custom field for a new site member\n\nYou can set the value of a custom field for a new site member in the `contactInfo`\nobject using the [`authentication.register()`](/authentication/register) function.\nUse a key:value pair in the top level of the `contactInfo` object, like this:\n\n```js\n{options:\n contactInfo: {\n 'my-custom-field-key': 'my-custom-field-value',\n 'my-custom-field-key-2': 'my-custom-field-value-2'\n }\n}\n```\n","displayName":"Custom Fields","slugifyName":"custom-fields"}],"namespaces":[{"name":"Authentication","slug":"authentication","fqn":"Authentication","standaloneTypes":[],"metadata":{},"actions":[{"name":"applySessionToken","fqn":"Authentication.applySessionToken","slug":"apply-session-token","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["sessionToken"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the token is applied."},"examples":[{"title":"Log in a member by applying a session token","content":"import { authentication } from 'wix-members-frontend';\n\n// ...\n\nauthentication.applySessionToken(sessionToken)\n .then(() => {\n console.log('Member logged in.');\n });"},{"title":"Register a member using a 3rd party for approval","description":"This example demonstrates a common 3rd-party approval flow.\nThe backend code calls a 3rd-party service that determines whether the member is approved.\nIf approved, `register()` is called from backend code,\nthe registration is approved,\nand a session token is returned to the calling page code.\nIf rejected, `blockByEmail()` is called.","content":"/*******************************\n * Backend code - register.web.js *\n *******************************/\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { authentication } from 'wix-members-backend';\nimport { approveBy3rdParty } from 'backend/some-backend-module';\n\nexport const doRegistration = webMethod(Permissions.Anyone, async (email, password, firstName, lastName) => {\n\n // Call a 3rd-party API to check if the member is approved.\n const isApproved = await approveBy3rdParty(email, password);\n\n // If member is approved by 3rd party, register and approve with the Wix site\n if (isApproved === true) {\n const options = {\n contactInfo: {\n firstName: firstName,\n lastName: lastName\n }\n };\n\n // Register the member\n const registration = await authentication.register(email, password, options);\n const approvalToken = registration.approvalToken;\n console.log('Member is now registered with the site and pending approval');\n\n // Approve the member and get session token, to be used to log in the member client-side\n const sessionToken = await authentication.approveByToken(approvalToken);\n console.log('Member is now approved, but not logged in');\n\n return {\n approved: true,\n sessionToken: sessionToken\n };\n\n } else {\n // If not approved by the 3rd party\n\n await authentication.blockByEmail(email);\n console.log('Member not approved by 3rd-party SSO. Blocking from Wix site.');\n\n return { approved: false };\n }\n});\n\n\n/*************\n * Page code *\n *************/\nimport { authentication } from 'wix-members-frontend';\nimport { doRegistration } from 'backend/register.web';\n\n// ...\n\n$w('#register').onClick(() => {\n\n const email = $w('#email').value;\n const password = $w('#password').value;\n const firstName = $w('#firstName').value;\n const lastName = $w('#lastName').value;\n\n doRegistration(email, password, firstName, lastName)\n .then((result) => {\n if (result.approved) {\n // Log the member in\n console.log('Logging in...');\n authentication.applySessionToken(result.sessionToken);\n } else {\n console.log('Not approved!');\n }\n });\n});\n"},{"title":"Log a member in after 3rd-party authentication","description":"This example contains a backend method that uses a 3rd-party service to authenticate a member.\nIf the authentication is successful,\na session token is returned to the page and used to log the member in.","content":"/****************************\n * Backend code - login.web.js *\n ***************************/\n\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { authentication } from 'wix-members-backend';\nimport { authBy3rdParty } from 'backend/authentications';\n\nexport const getLoginToken = webMethod(Permissions.Anyone, (email, password) => {\n\n return authBy3rdParty(email, password)\n .then((isAuthenticated) => {\n\n // If authenticated, generate and return the session token\n if (isAuthenticated) {\n return authentication.generateSessionToken(email)\n .then((sessionToken) => {\n return {\n sessionToken: sessionToken,\n approved: true\n };\n });\n }\n\n // If not authenticated, return non-approval\n return { approved: false };\n });\n});\n\n/*************\n * Page code *\n ************/\nimport { getLoginToken } from 'backend/login.web';\nimport { authentication } from 'wix-members-frontend';\n\n// ...\n\nconst email = $w('email').value;\nconst password = $w('password').value;\n\n// Call the backend function to get the session token\ngetLoginToken(email, password)\n .then((loginResult) => {\n if (loginResult.approved) {\n // If approved, log the member in using the returned session token\n authentication.applySessionToken(loginResult.sessionToken);\n } else {\n // If not approved, log a message\n console.log(\"Member not approved.\");\n }\n });"},{"title":"Register a member, sending an email for confirmation","description":"This example demonstrates a common email verification flow.\nA member is initially registered but not yet approved.\nAt registration, a verification email is sent with a link to a verification page.\nWhen the member goes to the verification page,\nthe approval is granted and the member is logged into the site.\n\n The code is split between 3 locations:\n\n - A backend web module named **register.web.js**.\n - The page code for the page where members register.\n - The page code for the page where members confirm their registration.","content":"/*******************************\n * Backend code - register.web.js *\n *******************************/\n\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { authentication } from 'wix-members-backend';\nimport { triggeredEmails } from 'wix-crm-backend';\n\nexport const doRegistration = webMethod(Permissions.Anyone, async (email, password, firstName, lastName) => {\n const registrationOptions = {\n contactInfo: {\n firstName: firstName,\n lastName: lastName\n }\n };\n const registration = await authentication.register(email, password, registrationOptions);\n console.log('Member is now registered with the site and pending approval');\n\n const emailOptions = {\n variables: {\n name: firstName,\n verifyLink: `http://yourdomain.com/post-register?token=${registration.approvalToken}`\n }\n };\n triggeredEmails.emailMember('verifyRegistration', registration.member.id, emailOptions);\n console.log('Confirmation email sent');\n});\n\nexport const doApproval = webMethod(Permissions.Anyone, async (token) => {\n try {\n const sessionToken = await authentication.approveByToken(token);\n console.log('Member approved');\n return {\n approved: true,\n sessionToken: sessionToken\n };\n } catch (error) {\n console.log('Member not approved');\n return {\n approved: false,\n reason: error\n };\n }\n});\n\n/****************************\n * Page code - registration *\n ****************************/\nimport { doRegistration } from 'backend/register.web';\n\n// ...\n\nconst email = $w('#email').value;\nconst password = $w('#password').value;\nconst firstName = $w('#firstName').value;\nconst lastName = $w('#lastName').value;\n\ndoRegistration(email, password, firstName, lastName)\n .then(() => {\n console.log('Confirmation email sent.');\n });\n\n/*********************************\n * Page code - post-registration *\n *********************************/\nimport wixLocationFrontend from 'wix-location-frontend';\nimport { authentication } from 'wix-members-frontend';\nimport { doApproval } from 'backend/register.web';\n\n$w.onReady(async () => {\n const token = wixLocationFrontend.query.token;\n\n const approval = await doApproval(token);\n\n if (approval.approved === true) {\n authentication.applySessionToken(approval.sessionToken);\n console.log('Member approved & logged in');\n } else {\n console.log('Member not approved');\n }\n});\n"}],"actionParams":[{"name":"sessionToken","slug":"session-token","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Session token to apply."}],"description":"Logs the current member into the site using the specified session token.\r\n\r\nYou receive a session token from the following methods:\r\n\r\n - `approveByEmail()` ([Velo](https://dev.wix.com/docs/velo/apis/wix-members-backend/authentication/approve-by-email))\r\n - `approveByToken()` ([Velo](https://dev.wix.com/docs/velo/apis/wix-members-backend/authentication/approve-by-token))\r\n - `register()` ([SDK](https://dev.wix.com/docs/sdk/backend-modules/identity/authentication/register-v2) | [Velo](https://dev.wix.com/docs/velo/apis/wix-members-backend/authentication/register))\r\n - [`generateSessionToken()`](https://dev.wix.com/docs/velo/api-reference/wix-members-backend/authentication/generate-session-token)\r\n - `login()` ([SDK](https://dev.wix.com/docs/sdk/backend-modules/identity/authentication/login-v2) | [Velo](https://dev.wix.com/docs/velo/apis/wix-members-backend/authentication/login))\r\n\r\n Pass the returned session token to a site's page code and apply it by\r\n calling `applySessionToken()` to complete the process started by one of the\r\n above methods.","sdkErrors":[],"kind":"GENERAL"},{"name":"changePassword","fqn":"Authentication.changePassword","slug":"change-password","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["newPassword","token"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the password is reset.\r\nRejected - Error message."},"examples":[{"title":"Change the member's password using a reset token","content":"import { authentication } from 'wix-members-frontend';\n\nauthentication\n .changePassword(newPassword, token)\n .then(() => {\n console.log('Password changed successfully');\n })\n .catch((error) => {\n console.error('Error changing password:', error);\n });"}],"actionParams":[{"name":"newPassword","slug":"new-password","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"New password the member wants to set. Minimum 6 characters."},{"name":"token","slug":"token","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Reset token received in the email triggered by `sendResetPasswordEmail()`."}],"description":"Changes the member's password to a new one, using a reset token.\r\n\r\n\r\n\r\n__Important:__\r\nThis method is in Developer Preview and is subject to change.","sdkErrors":[],"kind":"GENERAL"},{"name":"loggedIn","fqn":"Authentication.loggedIn","slug":"logged-in","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if a member is logged in. Otherwise, `false`."},"examples":[{"title":"Check whether a member is logged in","content":"import { authentication } from 'wix-members-frontend';\n\n// ...\n\nconst isLoggedIn = authentication.loggedIn();\n\nif (isLoggedIn) {\n console.log('Member is logged in');\n} else {\n console.log('Member is not logged in');\n}"},{"title":"Check for a logged-in member before getting member details","content":"import { authentication, currentMember } from 'wix-members-frontend';\n\n$w.onReady(async () => {\n const isLoggedIn = authentication.loggedIn();\n\n if (isLoggedIn) {\n const loggedInMember = await currentMember.getMember()\n console.log('Member is logged in:', loggedInMember);\n const memberId = loggedInMember._id;\n const contactId = loggedInMember.contactId;\n } else {\n // Handle when member isn't logged in\n }\n});"},{"title":"Show a logout button if a member is logged in","description":"This code example runs on `masterpage.js` and relies on a logout button,\nwhich is hidden when the page loads.\n\nWhen the page loads, if `loggedIn()` returns `true`,\nthe logout button is displayed.\nAdditionally, if a member logs in after the page loads,\nthe button is displayed in response to the login event.","content":"/*****************************\n * Page code - masterpage.js *\n ****************************/\n\nimport { authentication } from 'wix-members-frontend';\n\n$w.onReady(function () {\n const loggedIn = authentication.loggedIn();\n\n if (loggedIn) {\n console.log('Logged in, showing the logout button');\n $w('#logout').show();\n }\n\n authentication.onLogin(() => {\n console.log('Logged in, showing the logout button');\n $w('#logout').show();\n });\n});\n"}],"description":"Indicates whether the current site visitor is a logged-in member.\r\n\r\nIf a member is logged in, `loggedIn()` returns `true`.\r\nOtherwise, `loggedIn()` returns `false`.","sdkErrors":[],"kind":"GENERAL"},{"name":"login","fqn":"Authentication.login","slug":"login","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["email","password"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the member is logged in.\r\nRejected - Error message."},"examples":[{"title":"Log a member in","content":"import { authentication } from 'wix-members-frontend';\n\n// ...\n\nauthentication.login(email, password)\n .then(() => {\n console.log('Member is logged in');\n })\n .catch((error) => {\n console.error(error);\n });"},{"title":"Log a member in using data from input elements","content":"import { authentication } from 'wix-members-frontend';\n\n// ...\n\n$w('#login').onClick(async () => {\n const email = $w('#email').value;\n const password = $w('#password').value;\n\n try {\n await authentication.login(email, password);\n console.log('Member is logged in');\n } catch (error) {\n console.error(error);\n }\n});"}],"actionParams":[{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Login email address."},{"name":"password","slug":"password","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member password."}],"description":"Logs a registered member in with an email and password.\r\n\r\n`login()` only works with existing members. To register a new member use \r\n `register()` ([SDK](https://dev.wix.com/docs/sdk/backend-modules/identity/authentication/register-v2) | [Velo](https://dev.wix.com/docs/velo/apis/wix-members-backend/authentication/register)).\r\n\r\n> **Note:**\r\n> The frontend Members APIs aren't fully functional when previewing a site. View a published version of a site to see their complete functionality.","sdkErrors":[],"kind":"GENERAL"},{"name":"logout","fqn":"Authentication.logout","slug":"logout","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"Log the current member out","content":"import { authentication } from 'wix-members-frontend';\n\n// ...\n\nauthentication.logout();"},{"title":"Log the current member out when they click a button","content":"import { authentication } from 'wix-members-frontend';\n\n// ...\n\n$w('#logout').onClick(() => {\n authentication.logout();\n});"}],"description":"Logs the current member out of the site.\r\n\r\nThe `logout()` function logs the current member out of the site.\r\n\r\n> **Notes:**\r\n>\r\n> - The frontend Members APIs aren't fully functional when previewing a site. View a published version of a site to see their complete functionality.\r\n>\r\n> - The frontend Member APIs can only be used once the page has loaded. Therefore,\r\n> you must use them in code that's contained in or is called from the\r\n> `onReady()` or any element event.","sdkErrors":[],"kind":"GENERAL"},{"name":"onLogin","fqn":"Authentication.onLogin","slug":"on-login","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["handler"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"Run code when a member logs in","content":"import {authentication} from 'wix-members-frontend';\n\n// ...\n\nauthentication.onLogin(async (member) => {\n const loggedInMember = await member.getMember();\n const memberId = loggedInMember._id;\n console.log(`Member ${memberId} logged in:`, loggedInMember);\n});"}],"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LoginHandler","referenceFqn":"Authentication.LoginHandler","isFunction":true},"description":"Method name or expression to run when a member logs in."}],"description":"Sets the method that runs when a member logs in.\r\n\r\n`onLogin()` runs when a member logs into a site.\r\n\r\n`onLogin` receives a `currentMember` object for the logged-in member,\r\nwhich contains the `CurrentMember` API methods\r\nyou can use to retrieve the member's information.\r\n\r\nUsually, you want to call `onLogin()` in the **masterPage.js** file in the\r\ncode editor so that `onLogin()` runs no matter which\r\npage a member uses to log in.\r\n\r\n> **Notes:**\r\n>\r\n> - The frontend Members APIs aren't fully functional when previewing a site. View a published version of a site to see their complete functionality.\r\n>\r\n> - The frontend Member APIs can only be used once the page has loaded. Therefore,\r\n> you must use them in code that's contained in or is called from the\r\n> `onReady()` or any element event.","sdkErrors":[],"kind":"GENERAL"},{"name":"onLogout","fqn":"Authentication.onLogout","slug":"on-logout","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["handler"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"Run code when a member logs out","content":"import { authentication } from 'wix-members-frontend';\n\n// ...\n\nauthentication.onLogout(() => {\n console.log('Member logged out');\n});"}],"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LogoutHandler","referenceFqn":"Authentication.LogoutHandler","isFunction":true},"description":"Method name or expression to run when a member logs out."}],"description":"Sets the method that runs when a member logs out.\r\n\r\nUse `onLogout()` for code you want to run after a member logs out\r\nfrom a site.\r\n\r\n Usually, you want to call `onLogout()` in the **masterPage.js** file in the\r\n code editor so that `onLogout()` runs no matter which\r\n page on a site a member uses to log out.\r\n\r\n> **Notes:**\r\n>\r\n> - The frontend Members APIs aren't fully functional when previewing a site. View a published version of a site to see their complete functionality.\r\n>\r\n> - The frontend Member APIs can only be used once the page has loaded. Therefore,\r\n> you must use them in code that's contained in or is called from the\r\n> `onReady()` or any element event.","sdkErrors":[],"kind":"GENERAL"},{"name":"promptForgotPassword","fqn":"Authentication.promptForgotPassword","slug":"prompt-forgot-password","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the form is submitted.\r\nRejected - Message that the dialog was canceled, user is already logged in, or another reason the password reset failed."},"examples":[{"title":"Prompt the visitor with a password reset","content":"import { authentication } from 'wix-members-frontend';\n\n// ...\n\nauthentication.promptForgotPassword()\n .then(() => {\n console.log('Sending \"forgot password\" email');\n })\n .catch((error) => {\n console.error(error);\n });"}],"description":"Prompts the current site visitor with a password reset modal.\r\n\r\n`promptForgotPassword()` returns a Promise that resolves when\r\nthe visitor submits the **Create New Password** form.\r\n\r\nIf the visitor cancels the form without submitting it,\r\nthe Promise is rejected.\r\n\r\n`promptForgotPassword()` can't be called before the page is ready.\r\n\r\n> **Notes:**\r\n>\r\n> - The frontend Members APIs aren't fully functional when previewing a site. View a published version of a site to see their complete functionality.\r\n>\r\n> - The frontend Member APIs can only be used once the page has loaded. Therefore,\r\n> you must use them in code that's contained in or is called from the\r\n> `onReady()` or any element event.\r\n>\r\n> - If you `return` or `await` `promptForgotPassword()`\r\n> when calling from `onReady()`, the page is prevented from loading.\r\n> To handle the resolved promise, use `.then()` and `.catch()`.","sdkErrors":[],"kind":"GENERAL"},{"name":"promptLogin","fqn":"Authentication.promptLogin","slug":"prompt-login","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the member is logged in.\r\nRejected - Message that the dialog was canceled, or any other reason the member failed to log in."},"examples":[{"title":"Prompt the current visitor to log in","content":"import { authentication } from 'wix-members-frontend';\n\n// ...\n\n// Sample options value:\n// {\n// mode: 'login',\n// modal: true\n// }\n\nauthentication.promptLogin(options)\n .then(() => {\n console.log('Member is logged in');\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LoginOptions","referenceFqn":"Authentication.LoginOptions"},"description":"The options that determine how the login dialog box appears."}],"description":"Prompts the current visitor to log in as a site member.\r\n\r\n`promptLogin()` returns a Promise that resolves\r\nwhen the login has completed.\r\n\r\nIf the visitor cancels the form without logging in,\r\nthe Promise is rejected.\r\n\r\n`promptLogin()` can't be called before the page is ready.\r\n\r\n> **Notes:**\r\n>\r\n> - The frontend Members APIs aren't fully functional when previewing a site. View a published version of a site to see their complete functionality.\r\n>\r\n> - The frontend Member APIs can only be used once the page has loaded. Therefore,\r\n> you must use them in code that's contained in or is called from the\r\n> `onReady()` or any element event.\r\n>\r\n> - If you `return` or `await` `promptLogin()`\r\n> when calling from `onReady()`, the page is prevented from loading.\r\n> To handle the resolved promise, use `.then()` and `.catch()`.","sdkErrors":[],"kind":"GENERAL"},{"name":"register","fqn":"Authentication.register","slug":"register","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["email","password"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"RegistrationResult","referenceFqn":"Authentication.RegistrationResult"},"description":"Fulfilled - When the member is registered.\r\nRejected - Error message."},"examples":[{"title":"Register a site member","description":"This example contains a custom field, \"hobby\".","content":"import { authentication } from 'wix-members-frontend';\n\n// ...\n\n/* Sample options value:\n * {\n * contactInfo: {\n * firstName: 'Juan',\n * lastName: 'Doe',\n * picture: 'https://static.parastorage.com/unpkg-semver/communities-blog-statics/assets/wix-logo.png',\n * hobby: 'Football'\n * },\n * privacyStatus: \"PRIVATE\"\n * }\n */\n\nauthentication.register(email, password, options)\n .then((registrationResult) => {\n const status = registrationResult.status;\n\n if (status === \"PENDING\") {\n // When the site is configured for manual approval,\n // status is \"PENDING\" and approvalToken is returned.\n const approvalToken = registrationResult.approvalToken;\n console.log('Member registered and waiting for approval:', registrationResult);\n } else {\n // When the site is configured for automatic approval,\n // status is \"ACTIVE\" and the member is approved and logged in.\n // To prevent logging in the member automatically,\n // use the backend function: wix-members-backend.authentication.register()\n console.log('Member registered and logged in:', registrationResult);\n }\n })\n .catch((error) => {\n console.error(error);\n });"}],"actionParams":[{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Email address the new member will use to log in."},{"name":"password","slug":"password","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Password to assign to the new member.\r\nMust be 4 to 100 ASCII characters."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RegistrationOptions","referenceFqn":"Authentication.RegistrationOptions"},"description":"Registration options."}],"description":"Registers a new site member.\r\n\r\n`register()` returns a Promise that resolves to a `RegistrationResult`\r\n object when the member is registered or pending registration.\r\n\r\n The specified `password` must be between 4 and 100 ASCII characters.\r\n\r\n See New Members ([SDK](https://dev.wix.com/docs/sdk/frontend-modules/members/authentication/new-members) | [Velo](https://dev.wix.com/docs/velo/api-reference/wix-members-frontend/authentication/new-members)) to learn about verifying emails and approving members.\r\n\r\n > **Notes:**\r\n >\r\n > - The frontend Members APIs aren't fully functional when previewing a site. View a published version of a site to see their complete functionality.\r\n >\r\n > - The member data in the resolved Promise only includes custom fields from a site's contacts \r\n > if those [fields are added to a site's members in a dashboard](https://support.wix.com/en/article/site-members-customizing-your-member-profile-fields).\r\n >\r\n > - When a new member signs up using an email address\r\n > that's already in a site's Contact List,\r\n > a notification is displayed\r\n > and a confirmation email is sent to the new member.\r\n > To register a member without displaying the notification, use\r\n > `register()` ([SDK](https://dev.wix.com/docs/sdk/backend-modules/identity/authentication/register-v2) | [Velo](https://dev.wix.com/docs/velo/apis/wix-members-backend/authentication/register))\r\n > (this doesn't suppress the confirmation email).\r\n >\r\n > - When a site's member signup settings are set to automatic approval (see New Members ([SDK](https://dev.wix.com/docs/sdk/frontend-modules/members/authentication/new-members) | [Velo](https://dev.wix.com/docs/velo/api-reference/wix-members-frontend/authentication/new-members))), \r\n > calling the frontend `register()` in page code is as secure as calling `register()` in backend code, \r\n > unless you are implementing [custom site registration using code](https://dev.wix.com/docs/develop-websites/articles/code-tutorials/wix-members/creating-a-custom-registration-form-with-code).\r\n > However, when registration is set to [anual approval (see New Members ([SDK](https://dev.wix.com/docs/sdk/frontend-modules/members/authentication/new-members) | [Velo](https://dev.wix.com/docs/velo/api-reference/wix-members-frontend/authentication/new-members))),\r\n > calling `register()` from the backend code allows you to build more secure approval flows\r\n > by keeping tokens hidden from the frontend.","sdkErrors":[],"kind":"GENERAL"},{"name":"resendVerificationCodeEmail","fqn":"Authentication.resendVerificationCodeEmail","slug":"resend-verification-code-email","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the email is sent.\r\nRejected - Error message."},"examples":[{"title":"Email a member with a link to verify their email","content":"import { authentication } from 'wix-members-frontend';\n\nauthentication\n .resendVerificationCodeEmail()\n .then(() => {\n console.log('Verification code email resent');\n })\n .catch((error) => {\n console.error('Error resending verification email:', error);\n });"}],"description":"Resends a one-time password (OTP) for email verification.\r\n\r\n\r\n\r\n__Important:__\r\nThis method is in Developer Preview and is subject to change. \r\n\r\n\r\n\r\n`resendVerificationCodeEmail()` returns a Promise that resolves when the email is successfully sent, or rejects with an error if the operation fails.","sdkErrors":[],"kind":"GENERAL"},{"name":"sendResetPasswordEmail","fqn":"Authentication.sendResetPasswordEmail","slug":"send-reset-password-email","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["email"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the email is sent.\r\nRejected - Error message."},"examples":[{"title":"Email a member with a link to reset their password","content":"import { authentication } from 'wix-members-frontend';\n\nauthentication\n .sendResetPasswordEmail(email)\n .then((status) => {\n console.log('Password reset email sent'); \n })\n .catch((error) => {\n console.error('Error sending email:', error);\n });"}],"actionParams":[{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Login email of the member whose password will be set."}],"description":"Sends a site member an email with a link to set their password.\r\n\r\n\r\n\r\nImportant:\r\nThis method is in Developer Preview and is subject to change. \r\n\r\n\r\n\r\nThe reset password link is valid for 3 hours,\r\nand it can be used only once.\r\nIf the link expires, no changes are made to the password.","sdkErrors":[],"kind":"GENERAL"},{"name":"sendSetPasswordEmail","fqn":"Authentication.sendSetPasswordEmail","slug":"send-set-password-email","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["email"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"boolean"},"description":"Fulfilled - If the email is sent.\r\nRejected - Error message."},"examples":[{"title":"Email a member with a link to set their password","content":"import { authentication } from 'wix-members-frontend';\n\n/* Sample options value:\n* {\n* hideIgnoreMessage: true\n* }\n*/\n\nauthentication.sendSetPasswordEmail(email, options)\n .then((status) => {\n\n console.log(status);\n if (status === true) {\n\n console.log('Email sent!');\n }\n return status; \n })\n .catch((error) => {\n console.error(error);\n });\n\n/* Promise resolves to a boolean */"}],"actionParams":[{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Login email of the member whose password will be set."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SetPasswordEmailOptions","referenceFqn":"Authentication.SetPasswordEmailOptions"},"description":"Email display options."}],"description":"Sends a site member an email with a link to set their password.\r\n\r\n> **Deprecated.** Send Set Password Email has been replaced with Send Reset Password Email ([SDK](https://dev.wix.com/docs/sdk/frontend-modules/members/authentication/send-reset-password-email) | [Velo](https://dev.wix.com/docs/velo/apis/wix-members-frontend/authentication/send-reset-password-email)) and will be removed on September 30, 2025.\r\n\r\nThe set password link is valid for 3 hours,\r\nand it can be used only once.\r\nIf the link expires, no changes are made to the password.","sdkErrors":[],"kind":"GENERAL"},{"name":"verifyEmail","fqn":"Authentication.verifyEmail","slug":"verify-email","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["code"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - If the OTP is valid.\r\nRejected - Error message."},"examples":[{"title":"Verify the member's email address with a one-time password","content":"import { authentication } from 'wix-members-frontend';\n\nauthentication\n .verifyEmail(code)\n .then(() => {\n console.log('OTP verified'); \n })\n .catch((error) => {\n console.error('Error verifying OTP:', error);\n });"}],"actionParams":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"OTP code the member received in an email."}],"description":"Validates the email address using OTP (One-Time Password) that was sent during the registration.\r\n\r\n\r\n\r\n__Important:__\r\nThis method is in Developer Preview and is subject to change.","sdkErrors":[],"kind":"GENERAL"}],"webhooks":[],"articles":[{"content":"# Introduction\nTo use the Authentication API, import `{authentication}` from the `wix-members-frontend` module:\n\n```javascript\nimport { authentication } from 'wix-members-frontend';\n```","displayName":"Introduction","slugifyName":"introduction"},{"content":"# New Members\n\nWhen a new member registers for an account on your site, they can't immediately login. They must be approved as a member (which can be set to automatic), and you may wish to have them verify their email.\n\nYou can edit these settings in your site's [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmember-permissions/signup-login-settings).\n\n## Email verification\nYou may want to check that a new member is using their own email address, not using someone else's or a fake email address.\n\nTo run this check, require members to verify their email address once they've signed up in one of the following ways:\n- In your site's [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmember-permissions/signup-login-settings), under **Ask new members to confirm their email**.\n- Using code. [This example](https://www.wix.com/velo/example/members-area) includes email verification through code.\n\n\n## Manual vs automatic approval\nThe [register function](https://dev.wix.com/docs/velo/api-reference/wix-members-frontend/authentication/register) behaves differently depending on your [site's member signup settings](https://dev.wix.com/docs/develop-websites/articles/code-tutorials/wix-members/enabling-custom-site-registration).\n\n### Manual approval\nWhen manual approval is enabled, everyone who signs up must then be approved. Immediately after signing up, a new member's `status` is `\"PENDING\"`.\n\nYou can approve a new member by:\n- Passing the returned `approvalToken` to [`approveByToken()`](https://dev.wix.com/docs/velo/api-reference/wix-members-backend/authentication/approve-by-token) from wix-members-backend.\n- Calling [`approveByEmail()`](https://dev.wix.com/docs/velo/api-reference/wix-members-backend/authentication/approve-by-email) from wix-members-backend.\n- Navigating to your [site members list](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmember-permissions/members) in your dashboard and approving the new member there.\n\n>**Note:** If you need the `member` object, use [`register()`](https://dev.wix.com/docs/velo/api-reference/wix-members-backend/authentication/register) from wix-members-backend.\n\n### Automatic approval\nWhen automatic approval is enabled, everyone who signs up is approved. Immediately after signing up, a new member's `status` is `\"ACTIVE\"`.\n\nThe member is immediately logged in to the site.","displayName":"New Members","slugifyName":"new-members"}],"builderTypes":[],"properties":[]},{"name":"CurrentMember","slug":"current-member","fqn":"CurrentMember","standaloneTypes":[],"metadata":{},"actions":[{"name":"getMember","fqn":"CurrentMember.getMember","slug":"get-member","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Member","referenceFqn":"CurrentMember.Member"},"description":"Fulfilled - If a member is logged in, the retrieved member.\r\nIf a member isn't logged in, `undefined`."},"examples":[{"title":"Get the currently logged-in member","content":"import { currentMember } from 'wix-members-frontend';\n\n// ...\n\n// Sample options value:\n// {\n// fieldsets: [ 'FULL' ]\n// }\n\ncurrentMember.getMember(options)\n .then((member) => {\n const id = member._id;\n const fullName = `${member.contactDetails.firstName} ${member.contactDetails.lastName}`;\n return member;\n })\n .catch((error) => {\n console.error(error);\n });\n\n/* Promise resolves to:\n * {\n * \"_id\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"_createdDate\": \"2021-08-02T23:14:42Z\",\n * \"_updatedDate\": \"2021-08-02T23:14:58.345Z\",\n * \"lastLoginDate\": \"2021-08-12T19:46:33Z\",\n * \"loginEmail\": \"claude.morales@example.com\",\n * \"contactId\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"status\": \"APPROVED\",\n * \"privacyStatus\": \"PRIVATE\",\n * \"activityStatus\": \"ACTIVE\",\n * \"profile\": {\n * \"nickname\": \"Claude Morales\",\n * \"slug\": \"claudemorales\",\n * \"profilePhoto\": {\n * \"url\": \"//static.wixstatic.com/media/a27d24_0dd318~mv2.jpg\",\n * \"height\": 256,\n * \"width\": 256,\n * \"offsetX\": 1,\n * \"offsetY\": 1\n * },\n * \"coverPhoto\": {\n * \"url\": \"https://example.com/myimage.jpg\",\n * \"height\": 1080,\n * \"width\": 1920,\n * \"offsetX\": 1,\n * \"offsetY\": 1\n * },\n * \"title\": \"Awesome title\"\n * },\n * \"contactDetails\": {\n * \"firstName\": \"Claude\",\n * \"lastName\": \"Morales\",\n * \"phones\": [\n * \"0747-769-460\"\n * ],\n * \"emails\": [\n * \"claude.morales@example.com\"\n * ],\n * \"addresses\": [\n * {\n * \"country\": \"GB\"\n * },\n * {\n * \"_id\": \"f0f4d905-488d-44db-9080-fc29078cfad5\",\n * \"addressLine\": \"9373 Park Avenue\",\n * \"addressLine2\": \"Berkshire\",\n * \"city\": \"Ely\",\n * \"subdivision\": \"GB-ENG\",\n * \"country\": \"GB\",\n * \"postalCode\": \"PD50 8EU\"\n * }\n * ],\n * \"customFields\": {\n * \"custom.pronouns\": {\n * \"name\": \"Pronouns\",\n * \"value\": \"they/them\"\n * },\n * \"custom.nickname\": {\n * \"name\": \"Nickname\",\n * \"value\": \"Cee\"\n * }\n * }\n * }\n * }\n */"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FieldsetOptions","referenceFqn":"CurrentMember.FieldsetOptions"},"description":"Fieldset options."}],"description":"Retrieves the currently logged-in member.\r\n\r\n`getMember()` returns a Promise that resolves\r\nto the currently logged-in member, or `undefined` if a member isn't logged in.\r\n\r\n> **Notes:**\r\n> - The member data in the resolved promise will only include custom fields from a site's contacts if those [fields are added to a site's members in a dashboard](https://support.wix.com/en/article/site-members-customizing-your-member-profile-fields).\r\n> - The frontend Members APIs aren't fully functional when previewing a site. View a published version of a site to see their complete functionality.","sdkErrors":[],"kind":"GENERAL"},{"name":"getRoles","fqn":"CurrentMember.getRoles","slug":"get-roles","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Role","referenceFqn":"CurrentMember.Role"}},"description":"Fulfilled - List of roles.\r\nRejected - If no member is currently logged in."},"examples":[{"title":"Get the currently logged-in member's roles","content":"import { currentMember } from 'wix-members-frontend';\n\n// ...\n\ncurrentMember.getRoles()\n .then((roles) => {\n return roles;\n })\n .catch((error) => {\n console.error(error);\n });\n\n/* Returned roles array:\n * [\n * {\n * \"_id\": \"42082477-9616-4f15-bf1d-64b2b3049a42\",\n * \"_createdDate\": \"2021-01-31T23:26:56.089Z\",\n * \"title\": \"Forum Gatekeeper\",\n * \"description\": \"Can approve or block members, close discussions, and delete posts\",\n * \"color\": \"LIGHT_GREEN\"\n * },\n * {\n * \"_id\": \"9c3501b4-b8e0-4970-8795-d8ecfea698b7\",\n * \"_createdDate\": \"2021-01-31T23:26:17.535Z\",\n * \"title\": \"Forum Mod\",\n * \"description\": \"Can approve posts from new members and lock discussions\",\n * \"color\": \"VIOLET\"\n * },\n * {\n * \"_id\": \"00000000-0000-0000-0000-000000000001\",\n * \"title\": \"Admin\",\n * \"color\": \"DARK_BLUE\"\n * }\n * ]\n */"}],"description":"Retrieves the member's roles.\r\n\r\n`getRoles()` returns a Promise that resolves to the\r\n[roles](https://support.wix.com/en/article/site-members-creating-member-roles)\r\nof the currently logged-in member.\r\nIf no member is currently logged in, the Promise is rejected.\r\n\r\n> **Notes:**\r\n> - The member data in the resolved promise will only include custom fields from a site's contacts if those [fields are added to a site's members in a dashboard](https://support.wix.com/en/article/site-members-customizing-your-member-profile-fields).\r\n> - The frontend Members APIs aren't fully functional when previewing a site. View a published version of a site to see their complete functionality.\r\n\r\nThe following results are returned depending on the session identity:\r\n\r\n| Session Identity | Promise Resolves To |\r\n| ------------------------------------------------ | ---------------------------------------------------------------------- |\r\n| Logged-in member | Array of member roles |\r\n| Site owner or contributor with admin permissions | Array of member roles, plus an additional role where `name` is `Admin` |\r\n| Anyone else | Promise is rejected |","sdkErrors":[],"kind":"GENERAL"},{"name":"makeProfilePrivate","fqn":"CurrentMember.makeProfilePrivate","slug":"make-profile-private","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Member","referenceFqn":"CurrentMember.Member"},"description":"Fulfilled - Updated member."},"examples":[{"title":"Make the currently logged-in member's profile private","content":"import { currentMember } from 'wix-members-frontend';\n\n// ...\n\ncurrentMember.makeProfilePrivate()\n .then((updatedMember) => {\n const newPrivacyStatus = updatedMember.privacyStatus;\n console.log('Privacy status was changed to', newPrivacyStatus);\n })\n .catch((error) => {\n console.error(error);\n });\n\n/* Returned member object:\n * {\n * \"_id\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"_createdDate\": \"2021-08-02T23:14:42Z\",\n * \"_updatedDate\": \"2021-08-02T23:14:58.345Z\",\n * \"lastLoginDate\": \"2021-08-12T19:46:33Z\",\n * \"loginEmail\": \"claude.morales@example.com\",\n * \"contactId\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"status\": \"APPROVED\",\n * \"privacyStatus\": \"PRIVATE\",\n * \"activityStatus\": \"ACTIVE\",\n * \"profile\": {\n * \"nickname\": \"Claude Morales\",\n * \"slug\": \"claudemorales\"\n * },\n * \"contactDetails\": {\n * \"firstName\": \"Claude\",\n * \"lastName\": \"Morales\",\n * \"phones\": [\n * \"0747-769-460\"\n * ],\n * \"emails\": [\n * \"claude.morales@example.com\"\n * ],\n * \"addresses\": [\n * {\n * \"country\": \"GB\"\n * },\n * {\n * \"id\": \"f0f4d905-488d-44db-9080-fc29078cfad5\",\n * \"addressLine\": \"9373 Park Avenue\",\n * \"addressLine2\": \"Berkshire\",\n * \"city\": \"Ely\",\n * \"subdivision\": \"GB-ENG\",\n * \"country\": \"GB\",\n * \"postalCode\": \"PD50 8EU\"\n * }\n * ],\n * \"customFields\": {}\n * }\n * }\n */"}],"description":"Removes the currently logged-in member from the site community and sets their profile to private.\r\n\r\n`makeProfilePrivate()` returns a Promise that resolves to a member object\r\nwhen the member's profile privacy is updated.\r\n\r\nWhen a member's profile is private,\r\nthey don't have access to the site's\r\n[Members Area](https://support.wix.com/en/article/site-members-about-the-members-area)\r\nfeatures, and their profile is hidden from other members and site visitors.\r\n\r\n> **Notes:**\r\n> - The member data in the resolved promise will only include custom fields from a site's contacts if those [fields are added to a site's members in a dashboard](https://support.wix.com/en/article/site-members-customizing-your-member-profile-fields).\r\n> - The frontend Members APIs aren't fully functional when previewing a site. View a published version of a site to see their complete functionality.\r\n> - If a public member profile changes to private, their public content (such as forum posts and blog comments) remain publicly visible.","sdkErrors":[],"kind":"GENERAL"},{"name":"makeProfilePublic","fqn":"CurrentMember.makeProfilePublic","slug":"make-profile-public","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"Make the currently logged-in member's profile public","content":"import { currentMember } from 'wix-members-frontend';\n\n// ...\n\ncurrentMember.makeProfilePublic()\n .then((updatedMember) => {\n const newPrivacyStatus = updatedMember.privacyStatus;\n console.log('Privacy status was changed to', newPrivacyStatus);\n })\n .catch((error) => {\n console.error(error);\n });\n\n/* Returned updatedMember object:\n * {\n * \"_id\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"_createdDate\": \"2021-08-02T23:14:42Z\",\n * \"_updatedDate\": \"2021-08-02T23:14:58.345Z\",\n * \"lastLoginDate\": \"2021-08-12T19:46:33Z\",\n * \"loginEmail\": \"claude.morales@example.com\",\n * \"contactId\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"status\": \"APPROVED\",\n * \"privacyStatus\": \"PUBLIC\",\n * \"activityStatus\": \"ACTIVE\",\n * \"profile\": {\n * \"nickname\": \"Claude Morales\",\n * \"slug\": \"claudemorales\"\n * },\n * \"contactDetails\": {\n * \"firstName\": \"Claude\",\n * \"lastName\": \"Morales\",\n * \"phones\": [\n * \"0747-769-460\"\n * ],\n * \"emails\": [\n * \"claude.morales@example.com\"\n * ],\n * \"addresses\": [\n * {\n * \"country\": \"GB\"\n * },\n * {\n * \"id\": \"f0f4d905-488d-44db-9080-fc29078cfad5\",\n * \"addressLine\": \"9373 Park Avenue\",\n * \"addressLine2\": \"Berkshire\",\n * \"city\": \"Ely\",\n * \"subdivision\": \"GB-ENG\",\n * \"country\": \"GB\",\n * \"postalCode\": \"PD50 8EU\"\n * }\n * ],\n * \"customFields\": {}\n * }\n * }\n */"}],"description":"Joins the currently logged-in member to the site community and sets their profile to public.\r\n\r\n`makeProfilePublic()` returns a Promise that resolves to a member object\r\nwhen the member's profile privacy is updated.\r\n\r\nWhen a member's profile is public,\r\nthey have access to the site's\r\n[Members Area](https://support.wix.com/en/article/site-members-about-the-members-area)\r\nfeatures, such as chat, forum, and followers.\r\nAlso, their profile is visible to other members and site visitors.\r\n> **Notes:**\r\n> - The member data in the resolved promise will only include custom fields from a site's contacts if those [fields are added to a site's members in a dashboard](https://support.wix.com/en/article/site-members-customizing-your-member-profile-fields).\r\n> - The frontend Members APIs aren't fully functional when previewing a site. View a published version of a site to see their complete functionality.","sdkErrors":[],"kind":"GENERAL"}],"webhooks":[],"articles":[{"content":"# Introduction\nTo use the Current Member API, import `{currentMember}` from the `wix-members-frontend` module:\n\n```javascript\nimport { currentMember } from 'wix-members-frontend';\n```\n\n> **Note:** The frontend `CurrentMember` APIs aren't fully functional when previewing a site. View a published version of a site to see their complete functionality.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]}],"builderTypes":[],"properties":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.0","gitCommitHash":""},"resourceMetadata":{"lastModifiedBy":"","sourcePath":"","yamlPath":"","name":"wix-members-frontend","yamlTitle":"Wix Members Frontend 1 0 0","kind":"VELO"}}