{"id":"ccd2627c-d237-404e-b646-95eba27961e8","createdDate":"2024-09-30T09:44:46.343Z","updatedDate":"2024-09-30T09:44:46.343Z","resourceId":"e2922899-c385-4b85-b80d-90caf5aa2c5c","sdk":{"schema":{"name":"velo-deps_wix-members.v2_members","fqn":"","slug":"velo-deps-wix-members-v2-members","typesMap":{"ApproveMemberResponse":{"name":"ApproveMemberResponse","fqn":"ApproveMemberResponse","slug":"approve-member-response","actions":[],"properties":[{"name":"member","slug":"member","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"}}]},"Member":{"name":"Member","fqn":"Member","slug":"member","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time when the member was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time when the member was updated."},{"name":"activityStatus","slug":"activity-status","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ActivityStatusStatus","referenceFqn":"ActivityStatusStatus"},"description":"Member activity status.\n\n- `ACTIVE`: Member can write forum posts and blog comments.\n- `MUTED`: Member cannot write forum posts or blog comments.\n- `UNKNOWN`: Insufficient permissions to get the status."},{"name":"contact","slug":"contact","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Contact","referenceFqn":"Contact"},"description":"Member's contact information. Contact information is stored in the\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","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID."},{"name":"lastLoginDate","slug":"last-login-date","isReadOnly":true,"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":"loginEmailVerified","slug":"login-email-verified","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the email used by the member has been verified."},{"name":"privacyStatus","slug":"privacy-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PrivacyStatusStatus","referenceFqn":"PrivacyStatusStatus"},"description":"Member privacy status.\n\n- `PUBLIC`: Member is visible to everyone.\n- `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.\n- `UNKNOWN`: Insufficient permissions to get the status."},{"name":"profile","slug":"profile","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Profile","referenceFqn":"Profile"},"description":"Profile display info."},{"name":"status","slug":"status","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Status","referenceFqn":"Status"},"description":"Member site access status.\n\n- `PENDING`: Member created and is waiting for approval by site owner.\n- `APPROVED`: Member can log in to the site.\n- `OFFLINE`: Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-guest-authors-to-your-blog) for the site blog and cannot log in to the site.\n- `BLOCKED`: Member is blocked and cannot log in to the site.\n- `UNKNOWN`: Insufficient permissions to get the status."}]},"ActivityStatusStatus":{"name":"ActivityStatusStatus","fqn":"ActivityStatusStatus","slug":"activity-status-status","actions":[],"enumValues":["ACTIVE","MUTED","UNKNOWN"],"properties":[]},"Contact":{"name":"Contact","fqn":"Contact","slug":"contact","actions":[],"properties":[{"name":"addresses","slug":"addresses","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Address","referenceFqn":"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\"`.\n\nExample: `\"2020-03-15\"` for March 15, 2020."},{"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":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"REFERENCE","name":"CustomField","referenceFqn":"CustomField"}},"description":"Custom fields are structured as key:value pairs where each key is the field `name`, and each value is the field's `value` for the member.\n\n> **Notes:**\n> - Only custom fields added to the member profile in the Dashboard are available through the Members API. Empty fields are not returned.\n> - When 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."}]},"Address":{"name":"Address","fqn":"Address","slug":"address","actions":[],"oneofProperties":{"street":[{"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":"StreetAddress"},"description":"Street address object, with number and name in separate fields."}]},"properties":[{"name":"_id","slug":"id","isReadOnly":true,"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,\nsuch 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\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\n[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format."}]},"StreetAddress":{"name":"StreetAddress","fqn":"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."}]},"CustomField":{"name":"CustomField","fqn":"CustomField","slug":"custom-field","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom field name."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Custom field value."}]},"ExtendedFields":{"name":"ExtendedFields","fqn":"ExtendedFields","slug":"extended-fields","actions":[],"properties":[{"name":"namespaces","slug":"namespaces","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."}]},"PrivacyStatusStatus":{"name":"PrivacyStatusStatus","fqn":"PrivacyStatusStatus","slug":"privacy-status-status","actions":[],"enumValues":["PRIVATE","PUBLIC","UNKNOWN"],"properties":[]},"Profile":{"name":"Profile","fqn":"Profile","slug":"profile","actions":[],"properties":[{"name":"cover","slug":"cover","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Image","referenceFqn":"Image"},"description":"Member's cover photo,\nused as a background picture in members profile page.\n\nCover positioning can be altered with `cover.offsetX` and `cover.offsetY`.\nWhen left empty, the values default to `0`."},{"name":"nickname","slug":"nickname","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name that identifies the member to other members.\nDisplayed on the member's profile page\nand interactions in the forum or blog."},{"name":"photo","slug":"photo","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Image","referenceFqn":"Image"},"description":"Member's profile photo."},{"name":"slug","slug":"slug","isReadOnly":true,"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.\n\nCurrently available through the API only."}]},"Image":{"name":"Image","fqn":"Image","slug":"image","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Wix Media image ID,\nset when the member selects an image from Wix Media."},{"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.\n\nDefault: `0`."},{"name":"offsetY","slug":"offset-y","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Y-axis offset.\n\nDefault: `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."}]},"Status":{"name":"Status","fqn":"Status","slug":"status","actions":[],"enumValues":["APPROVED","BLOCKED","OFFLINE","PENDING","UNKNOWN"],"properties":[]},"BlockMemberResponse":{"name":"BlockMemberResponse","fqn":"BlockMemberResponse","slug":"block-member-response","actions":[],"properties":[{"name":"member","slug":"member","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"}}]},"BulkApproveMembersResponse":{"name":"BulkApproveMembersResponse","fqn":"BulkApproveMembersResponse","slug":"bulk-approve-members-response","actions":[],"properties":[{"name":"jobId","slug":"job-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Token to be used to query an \"async jobs service\""}]},"BulkBlockMembersResponse":{"name":"BulkBlockMembersResponse","fqn":"BulkBlockMembersResponse","slug":"bulk-block-members-response","actions":[],"properties":[{"name":"jobId","slug":"job-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Token to be used to query an \"async jobs service\""}]},"BulkDeleteMembersResponse":{"name":"BulkDeleteMembersResponse","fqn":"BulkDeleteMembersResponse","slug":"bulk-delete-members-response","actions":[],"properties":[{"name":"bulkActionMetadata","slug":"bulk-action-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkActionMetadata","referenceFqn":"BulkActionMetadata"},"description":"Bulk action result metadata"},{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"BulkMemberResult","referenceFqn":"BulkMemberResult"}},"description":"Results."}]},"BulkActionMetadata":{"name":"BulkActionMetadata","fqn":"BulkActionMetadata","slug":"bulk-action-metadata","actions":[],"properties":[{"name":"totalFailures","slug":"total-failures","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items that couldn't be processed."},{"name":"totalSuccesses","slug":"total-successes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items that were successfully processed."},{"name":"undetailedFailures","slug":"undetailed-failures","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of failures without details because detailed failure threshold was exceeded."}]},"BulkMemberResult":{"name":"BulkMemberResult","fqn":"BulkMemberResult","slug":"bulk-member-result","actions":[],"properties":[{"name":"itemMetadata","slug":"item-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemMetadata","referenceFqn":"ItemMetadata"}}]},"ItemMetadata":{"name":"ItemMetadata","fqn":"ItemMetadata","slug":"item-metadata","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item)."},{"name":"error","slug":"error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ApplicationError","referenceFqn":"ApplicationError"},"description":"Details about the error in case of failure."},{"name":"originalIndex","slug":"original-index","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Index of the item within the request array. Allows for correlation between request and response items."},{"name":"success","slug":"success","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated."}]},"ApplicationError":{"name":"ApplicationError","fqn":"ApplicationError","slug":"application-error","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Error code."},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Data related to the error."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description of the error."}]},"BulkDeleteMembersByFilterOptions":{"name":"BulkDeleteMembersByFilterOptions","fqn":"BulkDeleteMembersByFilterOptions","slug":"bulk-delete-members-by-filter-options","actions":[],"properties":[{"name":"contentAssigneeId","slug":"content-assignee-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of a member receiving deleted members' content."},{"name":"search","slug":"search","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Search","referenceFqn":"Search"},"description":"Plain text search."}]},"Search":{"name":"Search","fqn":"Search","slug":"search","actions":[],"properties":[{"name":"expression","slug":"expression","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Search term or expression"},{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Currently supported fields for search:\n\n- `loginEmail`\n- `contact.firstName`\n- `contact.lastName`\n- `profile.title`\n- `profile.nickname`\n- `profile.slug`\n\nDefault is `profile.nickname`"}]},"BulkDeleteMembersByFilterResponse":{"name":"BulkDeleteMembersByFilterResponse","fqn":"BulkDeleteMembersByFilterResponse","slug":"bulk-delete-members-by-filter-response","actions":[],"properties":[{"name":"jobId","slug":"job-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Token to be used to query an \"async jobs service\""}]},"CreateMemberOptions":{"name":"CreateMemberOptions","fqn":"CreateMemberOptions","slug":"create-member-options","actions":[],"properties":[{"name":"member","slug":"member","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"},"description":"Member to create."}]},"DeleteMemberOptions":{"name":"DeleteMemberOptions","fqn":"DeleteMemberOptions","slug":"delete-member-options","actions":[],"properties":[]},"DeleteMemberAddressesResponse":{"name":"DeleteMemberAddressesResponse","fqn":"DeleteMemberAddressesResponse","slug":"delete-member-addresses-response","actions":[],"properties":[{"name":"member","slug":"member","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"},"description":"Updated member."}]},"DeleteMemberEmailsResponse":{"name":"DeleteMemberEmailsResponse","fqn":"DeleteMemberEmailsResponse","slug":"delete-member-emails-response","actions":[],"properties":[{"name":"member","slug":"member","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"},"description":"Updated member."}]},"DeleteMemberPhonesResponse":{"name":"DeleteMemberPhonesResponse","fqn":"DeleteMemberPhonesResponse","slug":"delete-member-phones-response","actions":[],"properties":[{"name":"member","slug":"member","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"},"description":"Updated member."}]},"DeleteMyMemberOptions":{"name":"DeleteMyMemberOptions","fqn":"DeleteMyMemberOptions","slug":"delete-my-member-options","actions":[],"properties":[{"name":"contentAssigneeId","slug":"content-assignee-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of a member receiving deleted member's content"}]},"DisconnectMemberResponse":{"name":"DisconnectMemberResponse","fqn":"DisconnectMemberResponse","slug":"disconnect-member-response","actions":[],"properties":[{"name":"member","slug":"member","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"}}]},"GetCurrentMemberOptions":{"name":"GetCurrentMemberOptions","fqn":"GetCurrentMemberOptions","slug":"get-current-member-options","actions":[],"properties":[{"name":"fieldSet","slug":"field-set","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"REFERENCE","name":"Set","referenceFqn":"Set"},"description":"Predefined set of fields to return.\n\n- `\"FULL\"`: Returns all fields.\n- `\"PUBLIC\"`: Returns `_id` and all fields under `profile`.\n\n> **Note:**\n> When returning the `\"PUBLIC\"` fieldset,\n> `profile.status`, `profile.privacyStatus`, and `profile.activityStatus`\n> are returned as `\"UNKNOWN\"`."},{"name":"fieldsets","slug":"fieldsets","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Set","referenceFqn":"Set"}},"description":"Predefined set of fields to return. One of:\n\n- `FULL`: Returns all fields.\n- `PUBLIC`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.\n- `EXTENDED`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.\n\nDefault: `PUBLIC`."}]},"Set":{"name":"Set","fqn":"Set","slug":"set","actions":[],"enumValues":["EXTENDED","FULL","PUBLIC"],"properties":[]},"GetMyMemberResponse":{"name":"GetMyMemberResponse","fqn":"GetMyMemberResponse","slug":"get-my-member-response","actions":[],"properties":[{"name":"member","slug":"member","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"},"description":"The logged-in member."}]},"GetMemberOptions":{"name":"GetMemberOptions","fqn":"GetMemberOptions","slug":"get-member-options","actions":[],"properties":[{"name":"fieldsets","slug":"fieldsets","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Set","referenceFqn":"Set"}},"description":"Predefined set of fields to return. One of:\n- `\"FULL\"`: Returns all fields.\n- `\"PUBLIC\"`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.\n- `\"EXTENDED\"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.\n\nDefault: `\"PUBLIC\"`."}]},"JoinCommunityResponse":{"name":"JoinCommunityResponse","fqn":"JoinCommunityResponse","slug":"join-community-response","actions":[],"properties":[{"name":"member","slug":"member","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"},"description":"The updated member."}]},"LeaveCommunityResponse":{"name":"LeaveCommunityResponse","fqn":"LeaveCommunityResponse","slug":"leave-community-response","actions":[],"properties":[{"name":"member","slug":"member","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"},"description":"The updated member."}]},"ListMembersOptions":{"name":"ListMembersOptions","fqn":"ListMembersOptions","slug":"list-members-options","actions":[],"properties":[{"name":"fieldsets","slug":"fieldsets","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Set","referenceFqn":"Set"}},"description":"Predefined set of fields to return. One of:\n- `\"FULL\"`: Returns all fields.\n- `\"PUBLIC\"`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.\n- `\"EXTENDED\"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.\n\nDefault: `\"PUBLIC\"`."},{"name":"paging","slug":"paging","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Paging","referenceFqn":"Paging"},"description":"Paging options."},{"name":"sorting","slug":"sorting","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Sorting","referenceFqn":"Sorting"}},"description":"Sorting options."}]},"CursorPaging":{"name":"CursorPaging","fqn":"CursorPaging","slug":"cursor-paging","actions":[],"properties":[{"name":"cursor","slug":"cursor","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request."},{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum number of items to return in the results."}]},"Paging":{"name":"Paging","fqn":"Paging","slug":"paging","actions":[],"properties":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to load."},{"name":"offset","slug":"offset","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to skip in the current sort order."}]},"Sorting":{"name":"Sorting","fqn":"Sorting","slug":"sorting","actions":[],"properties":[{"name":"fieldName","slug":"field-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the field to sort by."},{"name":"order","slug":"order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SortOrder","referenceFqn":"SortOrder"},"description":"Sort order."}]},"SortOrder":{"name":"SortOrder","fqn":"SortOrder","slug":"sort-order","actions":[],"enumValues":["ASC","DESC"],"properties":[]},"ListMembersResponse":{"name":"ListMembersResponse","fqn":"ListMembersResponse","slug":"list-members-response","actions":[],"properties":[{"name":"members","slug":"members","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"}},"description":"List of members."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PagingMetadata","referenceFqn":"PagingMetadata"},"description":"Metadata for the paginated results."}]},"CursorPagingMetadata":{"name":"CursorPagingMetadata","fqn":"CursorPagingMetadata","slug":"cursor-paging-metadata","actions":[],"properties":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items returned in the response."},{"name":"cursors","slug":"cursors","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Cursors","referenceFqn":"Cursors"},"description":"Cursor strings that point to the next page, previous page, or both."},{"name":"hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether there are more pages to retrieve following the current page.\n\n+ `true`: Another page of results can be retrieved.\n+ `false`: This is the last page."}]},"Cursors":{"name":"Cursors","fqn":"Cursors","slug":"cursors","actions":[],"properties":[{"name":"next","slug":"next","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor string pointing to the next page in the list of results."},{"name":"prev","slug":"prev","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor pointing to the previous page in the list of results."}]},"PagingMetadata":{"name":"PagingMetadata","fqn":"PagingMetadata","slug":"paging-metadata","actions":[],"properties":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items returned in the response."},{"name":"offset","slug":"offset","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Offset that was requested."},{"name":"tooManyToCount","slug":"too-many-to-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Flag that indicates the server failed to calculate the `total` field."},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total number of items that match the query."}]},"MuteMemberResponse":{"name":"MuteMemberResponse","fqn":"MuteMemberResponse","slug":"mute-member-response","actions":[],"properties":[{"name":"member","slug":"member","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"}}]},"QueryMembersOptions":{"name":"QueryMembersOptions","fqn":"QueryMembersOptions","slug":"query-members-options","actions":[],"properties":[{"name":"fieldsets","slug":"fieldsets","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Set","referenceFqn":"Set"}},"description":"Predefined set of fields to return. One of:\n- `\"FULL\"`: Returns all fields.\n- `\"PUBLIC\"`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.\n- `\"EXTENDED\"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.\n\nDefault: `\"PUBLIC\"`."},{"name":"search","slug":"search","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Search","referenceFqn":"Search"},"description":"Plain text search."}]},"MembersQueryBuilder":{"name":"MembersQueryBuilder","fqn":"MembersQueryBuilder","slug":"members-query-builder","actions":[{"name":"eq","fqn":"MembersQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"MembersQueryBuilder","referenceFqn":"MembersQueryBuilder"},"examples":[{"title":"Add an `eq` filter to a query","content":"const query = members.queryMembers.eq('_id', 'some-id');\n"},{"title":"Create a query, add an `eq` filter, and run it","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members\n .queryMembers()\n .eq('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property equals the specified value.\n\nThe `eq()` function refines a `MembersQueryBuilder` to match only items where the value of the specified `propertyName` equals the specified `value`.\n`eq()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `eq()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"exists","fqn":"MembersQueryBuilder.exists","slug":"exists","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"MembersQueryBuilder","referenceFqn":"MembersQueryBuilder"},"examples":[{"title":"Add an `exists` filter to a query","content":"const query = members.queryMembers.exists('description', 'some-description');\n"},{"title":"Create a query, add an `exists` filter, and run it","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members\n .queryMembers()\n .exists('description', 'some-description')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"}}],"description":"Refines a query to match items where the specified property contains a value.\n\nThe `exists()` function refines a `MembersQueryBuilder` to only match items where the value of the specified `propertyName` doesn't equal null or undefined.\n `exists()` checks for either existence or non-existence based on the boolen parameter. Note that `exists()` does match items where the value of the specified `propertyName` is an empty string or an invalid value. `exists()` is only useful for properties which don't contain default values and therefore their values may be unassigned."},{"name":"find","fqn":"MembersQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"MembersQueryResult","referenceFqn":"MembersQueryResult"}},"examples":[{"title":"Run a query with no filters","content":"const query = members.queryMembers.find();\n"},{"title":"Perform a `find` on a query","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members.queryMembers().find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"description":"Returns the query results.\n\nThe `find()` function returns a Promise that resolves to the query results and metadata.\nThe Promise is rejected if `find()` is called with insufficient permissions or if any of the previous functions used to refine the query are invalid."},{"name":"hasSome","fqn":"MembersQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"MembersQueryBuilder","referenceFqn":"MembersQueryBuilder"},"examples":[{"title":"Add a `hasSome` filter to a query","content":"const query = members.queryMembers.hasSome('labelIds', [\n 'red',\n 'blue',\n 'purple',\n]);\n"},{"title":"Create a query, add a `hasSome` filter, and run it","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members\n .queryMembers()\n .hasSome('labelIds', ['red', 'blue', 'purple'])\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `values`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"any"}}}],"description":"Refines a query to match items whose specified property contains any of the specified values.\n\nThe `hasSome()` function refines a `MembersQueryBuilder` to match only items where the value of the specified `propertyName` equals any of the specified `values`.\nMatching strings with `hasSome()` is case-sensitive, so `'text'` isn't equal to `'Text'`.\nIf the specified property is an array, `hasSome()` matches if any of that array's elements equal any of the specified values."},{"name":"in","fqn":"MembersQueryBuilder.in","slug":"in","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"MembersQueryBuilder","referenceFqn":"MembersQueryBuilder"},"examples":[{"title":"Add an `in` filter to a query","content":"const query = members.queryMembers.in(\n ['labelIds', 'colors'],\n ['red', 'blue', 'purple']\n);\n"},{"title":"Create a query, add an `in` filter, and run it","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members\n .queryMembers()\n .in(['labelIds', 'colors'], ['red', 'blue', 'purple'])\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"}}],"description":"Refines a query to only match items where the specified property conatins any of the values in the provided array of values.\n\nThe `in()` function refines a `MembersQueryBuilder` to match only items where the specified `propertyName` is equal to any of the values in the provided array.\nMatching strings with `in()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"limit","fqn":"MembersQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"MembersQueryBuilder","referenceFqn":"MembersQueryBuilder"},"examples":[{"title":"Add a `limit` to a query","content":"const query = members.queryMembers.limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members.queryMembers().limit(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Add a `limit` to a query","content":"const query = members.queryMembers.limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members.queryMembers().limit(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to return, which is also the `pageSize` of the results object."}],"description":"Limits the number of items the query returns.\n\nThe `limit()` function defines the number of results a query returns in each page. Only one page of results is retrieved at a time.\nYou can use the `next()` and `prev()` functions to navigate the pages of a query result."},{"name":"ne","fqn":"MembersQueryBuilder.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"MembersQueryBuilder","referenceFqn":"MembersQueryBuilder"},"examples":[{"title":"Add an `ne` filter to a query","content":"const query = members.queryMembers.ne(\n '_id',\n 'bb19b637-74ce-55d3-ae32-430b588051da'\n);\n"},{"title":"Create a query, add an `ne` filter, and run it","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members\n .queryMembers()\n .ne('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property doesn't equal the specified value.\n\nThe `ne()` function refines a `MembersQueryBuilder` to match only items where the value of the specified `propertyName` doesn't equal the specified `value`.\n`ne()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `ne()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"skip","fqn":"MembersQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"MembersQueryBuilder","referenceFqn":"MembersQueryBuilder"},"examples":[{"title":"Add a `skip` to a query","content":"const query = members.queryMembers.skip(10);\n"},{"title":"Create a query, add a `skip`, and run it","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members.queryMembers().skip(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Add a `skip` to a query","content":"const query = members.queryMembers.skip(10);\n"},{"title":"Create a query, add a `skip`, and run it","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members.queryMembers().skip(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\n\nThe `skip()` function defines the number of results to skip before returning new query results.\nFor example, if you query a collection and 50 items match your query, but you set `skip()` to `10`, the first 10 items that match are ignored, and the 11th through 50th items are returned."},{"name":"startsWith","fqn":"MembersQueryBuilder.startsWith","slug":"starts-with","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"MembersQueryBuilder","referenceFqn":"MembersQueryBuilder"},"examples":[{"title":"Add a `startsWith` filter to a query","content":"const query = members.queryMembers.startsWith('_id', 'L');\n"},{"title":"Create a query, add a `startsWith` filter, and run it","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members.queryMembers();\n startsWith('_id', 'L').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `string`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}],"description":"Refines a query to match items where the specified property starts with the specified value.\n\nThe `startsWith()` function refines a `MembersQueryBuilder` to match only items where the value of the specified `propertyName` starts with the specified `string`.\nMatching with `startsWith()` is case-sensitive, so `'TEXT'` doesn't start with `'text'`.\nYou can only use `startsWith()` with a property whose value is a string."}],"properties":[]},"MembersQueryResult":{"name":"MembersQueryResult","fqn":"MembersQueryResult","slug":"members-query-result","actions":[{"name":"hasNext","fqn":"MembersQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean"},"examples":[{"title":"Get whether the query has more results","content":"const hasNext = results.hasNext();\n"},{"title":"Perform a query and get `hasNext` from the result","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members.queryMembers().find();\n\n return results.hasNext();\n}\n"}],"description":"Indicates whether the query has more results.\n\nYou can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `members` to navigate the pages of a query result."},{"name":"hasPrev","fqn":"MembersQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean"},"examples":[{"title":"Get whether the query has previous results","content":"const hasPrev = results.hasPrev();\n"},{"title":"Perform a query and get `hasPrev` from the result","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members.queryMembers().find();\n\n return results.hasPrev();\n}\n"}],"description":"Indicates whether the query has previous results.\n\nYou can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `members` to navigate the pages of a query result."},{"name":"next","fqn":"MembersQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"MembersQueryResult","referenceFqn":"MembersQueryResult"}},"examples":[{"title":"Get `next` from a query result","content":"const nextPage = results.next();\n"},{"title":"Perform a query and get `next` from the result","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members.queryMembers().find();\n\n return results.next();\n}\n"},{"title":"Iterate through all pages of query results","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n let allItems = [];\n\n const results = await members.queryMembers().limit(1000).find();\n allItems.push(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems.push(results.items);\n }\n\n return allItems;\n}\n"}],"description":"Retrieves the next page of query results.\n\nThe `next()` function retrieves the next page of query results.\nThe page size is defined by the [`limit()`](/members/members-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `members` to navigate the pages of a query result.\nIf items are added or removed between calls to `next()`, the values returned by `MembersQueryBuilder` may change."},{"name":"prev","fqn":"MembersQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"MembersQueryResult","referenceFqn":"MembersQueryResult"}},"examples":[{"title":"Get `prev` from a query result","content":"const previousPage = results.prev();\n"},{"title":"Perform a query and get `prev` from the result","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members.queryMembers().find();\n\n return results.prev();\n}\n"}],"description":"Retrieves the previous page of query results.\n\nThe `prev()` function retrieves the previous page of query results.\nThe page size is defined by the [`limit()`](/members/members-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `members` to navigate the pages of a query result.\nIf items are added or removed between calls to `prev()`, the values returned may change."}],"properties":[{"name":"currentPage","slug":"current-page","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `currentPage` from a query result","content":"const resultPage = results.currentPage;\n"},{"title":"Perform a query and get `currentPage` from the result","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members.queryMembers().find();\n\n return results.currentPage;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the index of the current page of results.\n\n`currentPage` is a zero-based index of the current page of results, meaning the 1st page is `0`, the 2nd page is `1`, and so on.\nIf no results match the query, `currentPage` is undefined.\nThe page size is defined by the [`limit()`](/members/members-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `members` to navigate the pages of a query result."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `items` from a query result","content":"const returnedItems = results.items;\n"},{"title":"Perform a query and get `items` from the result","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members.queryMembers().find();\n\n const returnedItems = results.items;\n\n if (returnedItems.length > 0) {\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"}},"description":"Returns an array of `members` items that match the query.\n\n`items` contains the current page of results retrieved by the query.\nIf no results match the query, `items` is an empty array.\nThe page size is defined by the [`limit()`](/members/members-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `members` to navigate the pages of a query result."},{"name":"length","slug":"length","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `length` from a query result","content":"const resultLength = results.length;\n"},{"title":"Perform a query and get `length` from the result","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members.queryMembers().find();\n\n return results.length;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current page of results.\n\n`length` returns just the number of items in the current page, not the total number of items that match the query. For the total number of items that match the query, see [`totalCount`](#totalcount).\nThe page size is defined by the [`limit()`](/members/members-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `members` to navigate the pages of a query result."},{"name":"pageSize","slug":"page-size","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query's page size","content":"const requestedPageSize = results.pageSize;\n"},{"title":"Perform a query and get `pageSize` from the result","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members.queryMembers().find();\n\n return results.pageSize;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the requested page size.\n\n`pageSize` returns the page size set in [`limit()`](/members/members-query-builder/limit) in `MembersQueryBuilder`."},{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `query` that produced the current result","content":"const originalQuery = results.query;\n"},{"title":"Perform a query and get `query` from the result","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members.queryMembers().find();\n\n return results.query;\n}\n"}],"type":{"kind":"REFERENCE","name":"MembersQueryBuilder","referenceFqn":"MembersQueryBuilder"},"description":"Returns the `MembersQueryBuilder` object used to get the current results.\n\nUse `query` to create and run a new query by chaining additional `MembersQueryBuilder` functions to it. You can filter only on properties that haven't already been used in the previous `MembersQueryBuilder`."},{"name":"totalCount","slug":"total-count","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `totalCount` from a query result","content":"const resultCount = results.totalCount;\n"},{"title":"Perform a query and get `totalCount` from the result","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members.queryMembers().find();\n\n return results.totalCount;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of items that match the query.\n\n`totalCount` returns the total number of items that match the query, not just the number of items in the current page. For the number of items in the current page, see [`length`](#length)."},{"name":"totalPages","slug":"total-pages","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `totalPages` from a query result","content":"const pageCount = results.totalPages;\n"},{"title":"Perform a query and get `totalPages` from the result","content":"import { members } from 'wix-members.v2';\n\nexport async function myQueryFunction() {\n const results = await members.queryMembers().find();\n\n return results.totalPages;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of pages the query produced.\n\nThe page size is defined by the [`limit()`](/members/members-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `members` to navigate the pages of a query result."}]},"UnmuteMemberResponse":{"name":"UnmuteMemberResponse","fqn":"UnmuteMemberResponse","slug":"unmute-member-response","actions":[],"properties":[{"name":"member","slug":"member","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"}}]},"UpdateMySlugResponse":{"name":"UpdateMySlugResponse","fqn":"UpdateMySlugResponse","slug":"update-my-slug-response","actions":[],"properties":[{"name":"member","slug":"member","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"},"description":"Updated member."}]},"UpdateMember":{"name":"UpdateMember","fqn":"UpdateMember","slug":"update-member","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time when the member was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time when the member was updated."},{"name":"activityStatus","slug":"activity-status","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ActivityStatusStatus","referenceFqn":"ActivityStatusStatus"},"description":"Member activity status.\n\n- `ACTIVE`: Member can write forum posts and blog comments.\n- `MUTED`: Member cannot write forum posts or blog comments.\n- `UNKNOWN`: Insufficient permissions to get the status."},{"name":"contact","slug":"contact","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Contact","referenceFqn":"Contact"},"description":"Member's contact information. Contact information is stored in the\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","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID."},{"name":"lastLoginDate","slug":"last-login-date","isReadOnly":true,"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":"loginEmailVerified","slug":"login-email-verified","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the email used by the member has been verified."},{"name":"privacyStatus","slug":"privacy-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PrivacyStatusStatus","referenceFqn":"PrivacyStatusStatus"},"description":"Member privacy status.\n\n- `PUBLIC`: Member is visible to everyone.\n- `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.\n- `UNKNOWN`: Insufficient permissions to get the status."},{"name":"profile","slug":"profile","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Profile","referenceFqn":"Profile"},"description":"Profile display info."},{"name":"status","slug":"status","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Status","referenceFqn":"Status"},"description":"Member site access status.\n\n- `PENDING`: Member created and is waiting for approval by site owner.\n- `APPROVED`: Member can log in to the site.\n- `OFFLINE`: Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-guest-authors-to-your-blog) for the site blog and cannot log in to the site.\n- `BLOCKED`: Member is blocked and cannot log in to the site.\n- `UNKNOWN`: Insufficient permissions to get the status."}]},"UpdateMemberSlugResponse":{"name":"UpdateMemberSlugResponse","fqn":"UpdateMemberSlugResponse","slug":"update-member-slug-response","actions":[],"properties":[{"name":"member","slug":"member","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"},"description":"Updated member."}]}},"standaloneTypes":[],"metadata":{"fqdn":"wix.members.v1.member"},"actions":[{"name":"createMember","fqn":"createMember","slug":"create-member","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","permissionIds":["MEMBERS.MEMBER_CREATE"],"permissions":["Manage Members"],"permissionsScopesIds":["SCOPE.DC-MEMBERS.MANAGE-MEMBERS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"},"description":"New member."},"examples":[{"title":"Create a new member with required parameter values (export from backend code)","content":"import { members } from 'wix-members.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedCreateMember = elevate(members.createMember); \n\n/* Sample member value:\n * {\n * \"member\": {\n * \"loginEmail\": \"examplemember@gmail.com\",\n * \"privacyStatus\": \"PUBLIC\"\n * }\n * }\n */\n\nexport const myCreateMemberFunction = webMethod(\n Permissions.Anyone,\n async (member) => {\n try {\n const newMember = await elevatedCreateMember(member);\n console.log('Created new member:', newMember);\n\n return newMember;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2024-02-29T09:42:31.000Z\",\n * \"_id\": \"29ae2752-73d2-4a07-8cba-677e1928ed52\",\n * \"_updatedDate\": \"2024-02-29T09:42:30.857Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contact\": {\n * \"addresses\": [],\n * \"contactId\": \"29ae2752-73d2-4a07-8cba-677e1928ed52\",\n * \"customFields\": {},\n * \"emails\": [],\n * \"phones\": []\n * },\n * \"loginEmail\": \"examplemember@gmail.com\",\n * \"loginEmailVerified\": false,\n * \"privacyStatus\": \"PUBLIC\",\n * \"profile\": {},\n * \"status\": \"APPROVED\"\n * }\n */"},{"title":"Create a new member with all parameter values (export from backend code)","content":"import { members } from 'wix-members.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedCreateMember = elevate(members.createMember);\n\n/* Sample member value:\n * {\n * \"member\": {\n * \"contact\": {\n * \"email\": \"jenny.smith@wixmembers.com\",\n * \"phone\": \"555-123-4567\",\n * \"address\": \"789 Member Lane, Townsville, USA\",\n * \"birthdate\": \"1985-07-15\",\n * \"company\": \"Wix Members Inc.\",\n * \"emails\": [\n * \"jenny.smith@wixmembers.com\",\n * \"jenny.smith@wix.com\"\n * ],\n * \"firstName\": \"Jenny\",\n * \"jobTitle\": \"Community Manager\",\n * \"lastName\": \"Smith\",\n * \"phones\": [\n * \"555-123-4567\",\n * \"555-987-6543\"\n * ],\n * \"addresses\": [\n * {\n * \"addressLine1\": \"123 Wix Way\",\n * \"addressLine2\": \"Suite 101\",\n * \"city\": \"Wixville\",\n * \"country\": \"US\",\n * \"postalCode\": \"54321\",\n * \"subdivision\": \"CA\"\n * },\n * {\n * \"addressLine1\": \"456 Wix Street\",\n * \"city\": \"Wixton\",\n * \"country\": \"US\",\n * \"postalCode\": \"12345\",\n * \"subdivision\": \"NY\"\n * }\n * ],\n * \"customFields\": {\n * \"membership_status\": {\n * \"name\": \"Membership Status\",\n * \"value\": \"Active\"\n * },\n * \"subscription_plan\": {\n * \"name\": \"Subscription Plan\",\n * \"value\": \"Premium\"\n * }\n * }\n * },\n * \"loginEmail\": \"jane.smith@wixmembers.com\",\n * \"privacyStatus\": \"PRIVATE\",\n * \"profile\": {\n * \"cover\": {\n * \"over\": {\n * \"_id\": \"wix_media_cover_789\",\n * \"height\": 720,\n * \"offsetX\": 50,\n * \"offsetY\": 20,\n * \"url\": \"https://wixmembers.com/cover.jpg\",\n * \"width\": 1280\n * },\n * \"url\": \"https://wixmembers.com/cover.jpg\",\n * \"offsetX\": 50,\n * \"offsetY\": 20\n * },\n * \"photo\": {\n * \"_id\": \"wix_media_photo_456\",\n * \"height\": 400,\n * \"offsetX\": 0,\n * \"offsetY\": 0,\n * \"url\": \"https://wixmembers.com/photo.jpg\",\n * \"width\": 400\n * },\n * \"nickname\": \"JennyS\",\n * \"title\": \"Community Moderator\"\n * }\n * }\n * }\n */\n\nexport const myCreateMemberFunction = webMethod(\n Permissions.Anyone,\n async (member) => {\n try {\n const newMember = await elevatedCreateMember(member);\n console.log('Created new member:', newMember);\n\n return newMember;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n\n/* Promise resolves to:\n * {\n * \"member\": {\n * \"_createdDate\": \"2024-03-01T14:41:09.000Z\",\n * \"_id\": \"44f427a2-d860-4b94-8618-5719be99fccd\",\n * \"_updatedDate\": \"2024-03-01T14:41:08.877Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contact\": {\n * \"addresses\": [\n * {\n * \"_id\": \"\",\n * \"addressLine2\": \"Suite 101\",\n * \"city\": \"Wixville\",\n * \"subdivision\": \"CA\",\n * \"country\": \"US\",\n * \"postalCode\": \"54321\"\n * },\n * {\n * \"_id\": \"\",\n * \"city\": \"Wixton\",\n * \"subdivision\": \"NY\",\n * \"country\": \"US\",\n * \"postalCode\": \"12345\"\n * }\n * ],\n * \"birthdate\": \"1985-07-15\",\n * \"company\": \"Wix Members Inc.\",\n * \"customFields\": {},\n * \"emails\": [],\n * \"firstName\": \"Jenny\",\n * \"jobTitle\": \"Community Manager\",\n * \"lastName\": \"Smith\",\n * \"phones\": [\n * \"555-123-4567\",\n * \"555-987-6543\"\n * ],\n * \"contactId\": \"44f427a2-d860-4b94-8618-5719be99fccd\"\n * },\n * \"loginEmail\": \"jane.smith@wixmembers.com\",\n * \"loginEmailVerified\": false,\n * \"privacyStatus\": \"PRIVATE\",\n * \"profile\": {\n * \"cover\": {\n * \"_id\": \"\",\n * \"url\": \"https://wixmembers.com/cover.jpg\",\n * \"height\": 0,\n * \"width\": 0\n * },\n * \"nickname\": \"JennyS\",\n * \"photo\": {\n * \"_id\": \"wix_media_photo_456\",\n * \"url\": \"//static.wixstatic.com/media/wix_media_photo_456\",\n * \"height\": 0,\n * \"width\": 0\n * },\n * \"title\": \"Community Moderator\"\n * },\n * \"status\": \"APPROVED\"\n * }\n * }\n */"},{"title":"Create members from a database ","description":"This code imports data from a Wix CMS collection and creates corresponding members using the `createMember()` API.","content":"/**************************************\n * Backend code - createMember.web.js *\n **************************************/\nimport { members } from 'wix-members.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\nimport wixData from 'wix-data';\n\nconst elevatedCreateMember = elevate(members.createMember);\n\nexport const myCreateMemberFunction = webMethod(\n Permissions.Anyone,\n async (member) => {\n try {\n const newMember = await elevatedCreateMember(member);\n console.log('Created new member:', newMember);\n return newMember;\n } catch (error) {\n console.error();\n // Handle the error\n }\n }\n );\n\nexport const importMembersFromCollection = webMethod(\n Permissions.Anyone, \n async function (collectionId) {\n try {\n let membersToImport = [];\n let currentPage = await wixData.query(collectionId).limit(1).find();\n membersToImport = [...membersToImport, ...currentPage.items];\n\n while (currentPage.hasNext()) {\n currentPage = await currentPage.next();\n membersToImport = [...membersToImport, ...currentPage.items];\n }\n\n for (const memberToImport of membersToImport) {\n await myCreateMemberFunction({\n loginEmail: memberToImport.loginEmail,\n privacyStatus: memberToImport.privacyStatus\n });\n }\n } catch (error) {\n console.error(\"An error occurred:\", error);\n // Handle the error\n }\n }\n);\n\n/*************\n * Page code *\n *************/\n\nimport { importMembersFromCollection } from 'backend/createMember.web.js';\n\n$w.onReady(function () {\n\n let collectionName = ''; \n \n //This example assumes there is a text input field called `collectionNameInput` on the site page.\n $w(\"#collectionNameInput\").onInput(event => {\n collectionName = event.target.value;\n });\n \n $w('#ButtonSiteMembersCollection').onClick(async () => {\n try {\n await importMembersFromCollection(collectionName);\n } catch (error) {\n console.error(\"An error occurred while handling button click:\", error);\n // Handle the error\n }\n });\n });"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CreateMemberOptions","referenceFqn":"CreateMemberOptions"}}],"description":"Creates a site member.\n\nAfter creation, you can use the `sendSetPasswordEmail()` function in the Members Authentication API to email the member with a link to set their password.\nThe member can log in to the site once they set their password for the first time.\n\n> **Note:**\n> When creating multiple members, set your requests at least 1 second apart to keep below rate limits.","permissionScopes":[{"name":"Manage Members","scopeId":"SCOPE.DC-MEMBERS.MANAGE-MEMBERS"}],"isAdminMethod":true},{"name":"deleteMember","fqn":"deleteMember","slug":"delete-member","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["_id"],"permissionIds":["MEMBERS.MEMBER_DELETE"],"permissions":["Manage Members"],"permissionsScopesIds":["SCOPE.DC-MEMBERS.MANAGE-MEMBERS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"Delete a member by ID (export from backend code)","content":"import { members } from 'wix-members.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedDeleteMember = elevate(members.deleteMember);\n\n/* Sample _id value: '29ae2752-73d2-4a07-8cba-677e1928ed52' */\n\nexport const myDeletedMemberFunction = webMethod(\n Permissions.Anyone,\n async (_id) => {\n try {\n const deletedMember = await elevatedDeleteMember(_id);\n console.log('Deleted member:', deletedMember);\n\n return deletedMember;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n\n/* Promise resolves to void */\n"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the member to delete."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeleteMemberOptions","referenceFqn":"DeleteMemberOptions"}}],"description":"Deletes a member.\n\nThe `deleteMember()` function returns a Promise that resolves to a member object when the specified member is deleted.\n\n>**Note:** This function permanently deletes a member. Once deleted, a member cannot be restored.","permissionScopes":[{"name":"Manage Members","scopeId":"SCOPE.DC-MEMBERS.MANAGE-MEMBERS"}],"isAdminMethod":true},{"name":"deleteMemberAddresses","fqn":"deleteMemberAddresses","slug":"delete-member-addresses","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["_id"],"permissionIds":["MEMBERS.MEMBER_UPDATE"],"permissions":["Manage Members","Manage Bookings Services and Settings","Manage Portfolio","Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.DC-MEMBERS.MANAGE-MEMBERS","SCOPE.BOOKINGS.CONFIGURATION","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP","MEMBER"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"DeleteMemberAddressesResponse","referenceFqn":"DeleteMemberAddressesResponse"}},"examples":[{"title":"Delete a member's address (export from backend code)","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { members } from 'wix-members.v2';\n\n/* Sample _id value: 'f32cbc51-a331-442b-86c2-2c664613e8b9' */\n\nexport const myDeleteAddressesFunction = webMethod(\n Permissions.Anyone, (id) => {\n return members.deleteMemberAddresses(id)\n .then((updatedMember) => {\n const addresses = updatedMember.contact.addresses;\n return updatedMember;\n })\n .catch((error) => {\n console.error(error);\n })\n });\n\n/* Promise resolves to:\n * {\n * \"_id\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"_createdDate\": \"2021-08-02T23:14:42.000Z\",\n * \"_updatedDate\": \"2021-08-02T23:14:58.345Z\",\n * \"lastLoginDate\": \"2021-08-02T23:17:29.000Z\",\n * \"contactId\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"loginEmail\": \"claude.morales@example.com\",\n * \"loginEmailVerified\": true,\n * \"status\": \"APPROVED\",\n * \"activityStatus\": \"ACTIVE\",\n * \"privacyStatus\": \"PUBLIC\",\n * \"contact\": {\n * \"firstName\": \"Claude\",\n * \"lastName\": \"Morales\",\n * \"phones\": [\n * \"0747-769-460\"\n * ],\n * \"emails\": [\n * \"claude.morales@example.com\"\n * ],\n * \"addresses\": [],\n * \"customFields\": {}\n * },\n * \"profile\": {\n * \"nickname\": \"Claude Morales\",\n * \"slug\": \"claudemorales\"\n * }\n * }\n */\n"},{"title":"Delete a member's address with elevated permissions (export from backend code)","content":"import { members } from 'wix-members.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedDeleteMemberAddresses = elevate(members.deleteMemberAddresses);\n\n/* Sample _id value: '20aca292-e791-45b4-902f-7e7e22c96dd5' */\n\nexport const myDeleteMemberAddressesFunction = webMethod(\n Permissions.Anyone,\n async (_id) => {\n try {\n const member = await elevatedDeleteMemberAddresses(_id);\n console.log('Deleted members address: ', member);\n\n return member;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n\n/* Promise resolves to:\n * \"member\": {\n * \"_createdDate\": \"2024-02-28T10:42:31.000Z\",\n * \"_id\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"_updatedDate\": \"2024-02-28T10:42:30.891Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contact\": {\n * \"contactId\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"firstName\": \"John\",\n * \"lastName\": \"Jonas\",\n * \"phones\": [\n * \"6 52894975\"\n * ],\n * \"emails\": [],\n * \"addresses\": [],\n * \"customFields\": {}\n * },\n * \"contactId\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"lastLoginDate\": \"2024-02-28T10:42:31.000Z\",\n * \"loginEmail\": \"johnjonas@gmail.com\",\n * \"loginEmailVerified\": false,\n * \"privacyStatus\": \"PRIVATE\",\n * \"profile\": {\n * \"nickname\": \"johnjonas\",\n * \"slug\": \"johnjonas\"\n * },\n * \"status\": \"APPROVED\"\n * }\n * }\n */"},{"title":"Delete a member's address (dashboard page code)","content":"import { members } from 'wix-members.v2';\n\n/* Sample _id value: '20aca292-e791-45b4-902f-7e7e22c96dd5' */\n\nexport async function MyDeleteMemberAddresses(_id) {\n try {\n const member = await members.deleteMemberAddresses(_id);\n console.log('Deleted members address: ', member);\n\n return member;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * \"member\": {\n * \"_createdDate\": \"2024-02-28T10:42:31.000Z\",\n * \"_id\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"_updatedDate\": \"2024-02-28T10:42:30.891Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contact\": {\n * \"contactId\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"firstName\": \"John\",\n * \"lastName\": \"Jonas\",\n * \"phones\": [\n * \"6 52894975\"\n * ],\n * \"emails\": [],\n * \"addresses\": [],\n * \"customFields\": {}\n * },\n * \"contactId\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"lastLoginDate\": \"2024-02-28T10:42:31.000Z\",\n * \"loginEmail\": \"johnjonas@gmail.com\",\n * \"loginEmailVerified\": false,\n * \"privacyStatus\": \"PRIVATE\",\n * \"profile\": {\n * \"nickname\": \"johnjonas\",\n * \"slug\": \"johnjonas\"\n * },\n * \"status\": \"APPROVED\"\n * }\n * }\n */"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the member whose street addresses will be deleted."}],"description":"Deletes a member's street addresses.\n\nThe `deleteMemberAddresses()` function clears the `addresses` array under the `contact` property.\n\n> **Note:**\n> Only logged-in members can call this function without elevated permissions.\n> To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.","permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Members","scopeId":"SCOPE.DC-MEMBERS.MANAGE-MEMBERS"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":false},{"name":"deleteMemberEmails","fqn":"deleteMemberEmails","slug":"delete-member-emails","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["_id"],"permissionIds":["MEMBERS.MEMBER_UPDATE"],"permissions":["Manage Members","Manage Bookings Services and Settings","Manage Portfolio","Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.DC-MEMBERS.MANAGE-MEMBERS","SCOPE.BOOKINGS.CONFIGURATION","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP","MEMBER"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"DeleteMemberEmailsResponse","referenceFqn":"DeleteMemberEmailsResponse"}},"examples":[{"title":"Delete a member's email (export from backend code)","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { members } from 'wix-members.v2';\n\n/* Sample _id value: 'f32cbc51-a331-442b-86c2-2c664613e8b9' */\n\nexport const myDeleteEmailsFunction = webMethod(Permissions.Anyone, (id) => {\n return members.deleteMemberEmails(id)\n .then((updatedMember) => {\n const emails = updatedMember.contact.emails;\n return updatedMember;\n })\n .catch((error) => {\n console.error(error);\n })\n});\n\n/* Promise resolves to:\n * {\n * \"_id\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"_createdDate\": \"2021-08-02T23:14:42.000Z\",\n * \"_updatedDate\": \"2021-08-02T23:14:58.345Z\",\n * \"lastLoginDate\": \"2021-08-02T23:17:29.000Z\",\n * \"contactId\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"loginEmail\": \"claude.morales@example.com\",\n * \"loginEmailVerified\": true,\n * \"status\": \"APPROVED\",\n * \"activityStatus\": \"ACTIVE\",\n * \"privacyStatus\": \"PUBLIC\",\n * \"contact\": {\n * \"firstName\": \"Claude\",\n * \"lastName\": \"Morales\",\n * \"phones\": [\n * \"0747-769-460\"\n * ],\n * \"emails\": [],\n * \"addresses\": [\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 * \"profile\": {\n * \"nickname\": \"Claude Morales\",\n * \"slug\": \"claudemorales\"\n * }\n * }\n */\n"},{"title":"Delete a member's email with elevated permissions (export from backend code)","content":"import { members } from 'wix-members.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedDeleteMemberEmails = elevate(members.deleteMemberEmails);\n\n/* Sample _id value: '20aca292-e791-45b4-902f-7e7e22c96dd5' */\n\nexport const myDeleteMemberEmailsFunction = webMethod(\n Permissions.Anyone,\n async (_id) => {\n try {\n const member = await elevatedDeleteMemberEmails(_id);\n console.log('Deleted members email: ', member);\n\n return member;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n\n/* Promise resolves to:\n * \"member\": {\n * \"_createdDate\": \"2024-02-28T10:42:31.000Z\",\n * \"_id\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"_updatedDate\": \"2024-02-28T10:42:30.891Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contact\": {\n * \"contactId\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"firstName\": \"John\",\n * \"lastName\": \"Jonas\",\n * \"phones\": [\n * \"6 52894975\"\n * ],\n * \"emails\": [],\n * \"addresses\": [],\n * \"customFields\": {}\n * },\n * \"contactId\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"lastLoginDate\": \"2024-02-28T10:42:31.000Z\",\n * \"loginEmail\": \"johnjonas@gmail.com\",\n * \"loginEmailVerified\": false,\n * \"privacyStatus\": \"PRIVATE\",\n * \"profile\": {\n * \"nickname\": \"johnjonas\",\n * \"slug\": \"johnjonas\"\n * },\n * \"status\": \"APPROVED\"\n * }\n * }\n */"},{"title":"Delete a member's email (Dashboard page code) ","content":"import { members } from 'wix-members.v2';\n\n/* Sample _id value: 'f32cbc51-a331-442b-86c2-2c664613e8b9' */\n\nexport async function myDeleteEmailsFunction(_id) {\n try {\n const member = await members.deleteMemberEmails(_id);\n console.log('Deleted members email: ', member);\n\n return member;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * {\n * \"_id\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"_createdDate\": \"2021-08-02T23:14:42.000Z\",\n * \"_updatedDate\": \"2021-08-02T23:14:58.345Z\",\n * \"lastLoginDate\": \"2021-08-02T23:17:29.000Z\",\n * \"contactId\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"loginEmail\": \"claude.morales@example.com\",\n * \"loginEmailVerified\": true,\n * \"status\": \"APPROVED\",\n * \"activityStatus\": \"ACTIVE\",\n * \"privacyStatus\": \"PUBLIC\",\n * \"contact\": {\n * \"firstName\": \"Claude\",\n * \"lastName\": \"Morales\",\n * \"phones\": [\n * \"0747-769-460\"\n * ],\n * \"emails\": [],\n * \"addresses\": [\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 * \"profile\": {\n * \"nickname\": \"Claude Morales\",\n * \"slug\": \"claudemorales\"\n * }\n * }\n */\n"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the member whose email addresses will be deleted."}],"description":"Clears a member's email addresses.\n\nThe `deleteMemberEmails()` function clears the `emails` array under the `contact` property.\n\n> **Notes:**\n> A member can still log in with their `loginEmail`,\n> which is not cleared when this function is called.\n\n> Only logged-in members can call this function without elevated permissions.\n> To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.","permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Members","scopeId":"SCOPE.DC-MEMBERS.MANAGE-MEMBERS"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":false},{"name":"deleteMemberPhones","fqn":"deleteMemberPhones","slug":"delete-member-phones","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["_id"],"permissionIds":["MEMBERS.MEMBER_UPDATE"],"permissions":["Manage Members","Manage Bookings Services and Settings","Manage Portfolio","Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.DC-MEMBERS.MANAGE-MEMBERS","SCOPE.BOOKINGS.CONFIGURATION","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP","MEMBER"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"DeleteMemberPhonesResponse","referenceFqn":"DeleteMemberPhonesResponse"}},"examples":[{"title":"Delete a member's phone numbers (export from backend code)","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { members } from 'wix-members.v2';\n\n/* Sample _id value: 'f32cbc51-a331-442b-86c2-2c664613e8b9' */\n\nexport const myDeletePhonesFunction = webMethod(Permissions.Anyone, (id) => {\n return members.deleteMemberPhones(id)\n .then((updatedMember) => {\n const phones = updatedMember.contact.phones;\n return updatedMember;\n })\n .catch((error) => {\n console.error(error);\n })\n});\n\n/* Promise resolves to:\n * {\n * \"_id\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"_createdDate\": \"2021-08-02T23:14:42.000Z\",\n * \"_updatedDate\": \"2021-08-02T23:14:58.345Z\",\n * \"lastLoginDate\": \"2021-08-02T23:17:29.000Z\",\n * \"contactId\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"loginEmail\": \"claude.morales@example.com\",\n * \"loginEmailVerified\": true,\n * \"status\": \"APPROVED\",\n * \"activityStatus\": \"ACTIVE\",\n * \"privacyStatus\": \"PUBLIC\",\n * \"contact\": {\n * \"firstName\": \"Claude\",\n * \"lastName\": \"Morales\",\n * \"phones\": [],\n * \"emails\": [\n * \"claude.morales@example.com\"\n * ],\n * \"addresses\": [\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 * \"profile\": {\n * \"nickname\": \"Claude Morales\",\n * \"slug\": \"claudemorales\"\n * }\n * }\n */\n"},{"title":"Delete a member's phone numbers with elevated permissions (export from backend code)","content":"import { members } from 'wix-members.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedDeleteMemberPhones = elevate(members.deleteMemberPhones);\n\n/* Sample _id value: '20aca292-e791-45b4-902f-7e7e22c96dd5' */\n\nexport const myDeleteMemberPhones = webMethod(\n Permissions.Anyone,\n async (_id) => {\n try {\n const member = await elevatedDeleteMemberPhones(_id);\n console.log('Deleted members phone: ', member);\n\n return member;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n\n/* Promise resolves to:\n *\n * {\n * \"_createdDate\": \"2024-02-28T10:42:31.000Z\",\n * \"_id\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"_updatedDate\": \"2024-02-28T10:42:30.891Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contact\": {\n * \"contactId\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"firstName\": \"John\",\n * \"lastName\": \"Jonas\",\n * \"phones\": [],\n * \"emails\": [],\n * \"addresses\": [],\n * \"customFields\": {}\n * },\n * \"contactId\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"lastLoginDate\": \"2024-02-28T10:42:31.000Z\",\n * \"loginEmail\": \"johnjonas@gmail.com\",\n * \"loginEmailVerified\": false,\n * \"privacyStatus\": \"PRIVATE\",\n * \"profile\": {\n * \"nickname\": \"johnjonas\",\n * \"slug\": \"johnjonas\"\n * },\n * \"status\": \"APPROVED\"\n * }\n * \n */"},{"title":"Delete a member's phone numbers (dashboard page code)","content":"import { members } from 'wix-members.v2';\n\n/* Sample _id value: '20aca292-e791-45b4-902f-7e7e22c96dd5' */\n\nexport async function myDeleteMemberPhones(_id){\n try {\n const member = await members.deleteMemberPhones(_id);\n console.log('Deleted members phone: ', member);\n\n return member;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n};\n\n/* Promise resolves to:\n *\n * {\n * \"_createdDate\": \"2024-02-28T10:42:31.000Z\",\n * \"_id\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"_updatedDate\": \"2024-02-28T10:42:30.891Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contact\": {\n * \"contactId\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"firstName\": \"John\",\n * \"lastName\": \"Jonas\",\n * \"phones\": [],\n * \"emails\": [],\n * \"addresses\": [],\n * \"customFields\": {}\n * },\n * \"contactId\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"lastLoginDate\": \"2024-02-28T10:42:31.000Z\",\n * \"loginEmail\": \"johnjonas@gmail.com\",\n * \"loginEmailVerified\": false,\n * \"privacyStatus\": \"PRIVATE\",\n * \"profile\": {\n * \"nickname\": \"johnjonas\",\n * \"slug\": \"johnjonas\"\n * },\n * \"status\": \"APPROVED\"\n * }\n * \n */"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the member whose phone numbers will be deleted."}],"description":"Clears a member's phone numbers.\n\nThe `deleteMemberPhones()` function clears the `phones` array under the `contact` property.\n\n> **Note:**\n> Only logged-in members can call this function without elevated permissions.\n> To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.","permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Members","scopeId":"SCOPE.DC-MEMBERS.MANAGE-MEMBERS"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":false},{"name":"getCurrentMember","fqn":"getCurrentMember","slug":"get-current-member","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","permissionIds":["MEMBERS.MEMBER_READ"],"permissions":["Manage Members","Manage Bookings Services and Settings","Manage Portfolio","Read Members and Contacts - all read permissions","Manage Restaurants - all permissions","Read Members","Manage Members and Contacts - all permissions"],"permissionsScopesIds":["SCOPE.DC-MEMBERS.MANAGE-MEMBERS","SCOPE.BOOKINGS.CONFIGURATION","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS","SCOPE.RESTAURANTS.MEGA-SCOPES","SCOPE.DC-MEMBERS.READ-MEMBERS","SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"GetMyMemberResponse","referenceFqn":"GetMyMemberResponse"},"description":"Member profile."},"examples":[{"title":"Get currently logged in member (export from backend code)","content":"import { members } from 'wix-members.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\n\n /* Sample options value:\n * {\n * fieldsets: [ 'FULL' ]\n * }\n */\n\nexport const myGetCurrentMemberFunction = webMethod(\n Permissions.Anyone,\n async () => {\n try {\n const member = await members.getCurrentMember();\n console.log('Retrieved currently logged in member:', member);\n\n return member;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n\n/* Promise resolves to:\n *\n * {\n * \"_createdDate\": \"2024-02-22T13:52:00.000Z\",\n * \"_id\": \"7d368843-6f0c-4037-8d0e-b7e36a8a0c32\",\n * \"_updatedDate\": \"2024-02-22T13:52:00.674Z\",\n * \"activityStatus\": \"UNKNOWN\",\n * \"contactId\": \"ff20c02e-3d13-4412-9529-d628aa0abc12\",\n * \"privacyStatus\": \"UNKNOWN\",\n * \"profile\": {\n * \"nickname\": \"Maverick\",\n * \"slug\": \"maverick123\",\n * \"photo\": {\n * \"url\": \"https://example.com/photo.jpg\",\n * \"height\": 0,\n * \"width\": 0,\n * \"_id\": \"\"\n * }\n * },\n * \"status\": \"UNKNOWN\"\n * }\n *\n */"},{"title":"Get currently logged in member (dashboard page code)","content":"import { members } from 'wix-members.v2';\n\n /* Sample options value:\n * {\n * fieldsets: [ 'FULL' ]\n * }\n */\n\nexport async function myGetCurrentMemberFunction(options){\n try {\n const member = await members.getCurrentMember();\n console.log('Retrieved currently logged in member:', member);\n\n return member;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n *\n * {\n * \"_createdDate\": \"2024-02-22T13:52:00.000Z\",\n * \"_id\": \"7d368843-6f0c-4037-8d0e-b7e36a8a0c32\",\n * \"_updatedDate\": \"2024-02-22T13:52:00.674Z\",\n * \"activityStatus\": \"UNKNOWN\",\n * \"contactId\": \"ff20c02e-3d13-4412-9529-d628aa0abc12\",\n * \"privacyStatus\": \"UNKNOWN\",\n * \"profile\": {\n * \"nickname\": \"Maverick\",\n * \"slug\": \"maverick123\",\n * \"photo\": {\n * \"url\": \"https://example.com/photo.jpg\",\n * \"height\": 0,\n * \"width\": 0,\n * \"_id\": \"\"\n * }\n * },\n * \"status\": \"UNKNOWN\"\n * }\n *\n */"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GetCurrentMemberOptions","referenceFqn":"GetCurrentMemberOptions"}}],"description":"Retrieves the currently logged-in member.","permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Members","scopeId":"SCOPE.DC-MEMBERS.MANAGE-MEMBERS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Read Members","scopeId":"SCOPE.DC-MEMBERS.READ-MEMBERS"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"isAdminMethod":false},{"name":"getMember","fqn":"getMember","slug":"get-member","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["_id"],"permissionIds":["MEMBERS.MEMBER_READ"],"permissions":["Manage Members","Manage Bookings Services and Settings","Manage Portfolio","Read Members and Contacts - all read permissions","Manage Restaurants - all permissions","Read Members","Manage Members and Contacts - all permissions"],"permissionsScopesIds":["SCOPE.DC-MEMBERS.MANAGE-MEMBERS","SCOPE.BOOKINGS.CONFIGURATION","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS","SCOPE.RESTAURANTS.MEGA-SCOPES","SCOPE.DC-MEMBERS.READ-MEMBERS","SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"},"description":"The requested member."},"examples":[{"title":"Get a member by ID with minimum parameters (export from backend code)","content":"import { members } from 'wix-members.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\n/* Sample _id value: '60a91ab6-5e30-4af2-9d5e-a205c351ffd7' */\n\nconst elevatedgetMember = elevate(members.getMember); \n\nexport const myGetMemberFunction = webMethod(\n Permissions.Anyone,\n async (_id, options) => {\n try {\n const member = await elevatedgetMember(_id, options);\n console.log('Member retrieved:', member);\n\n return member;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2024-02-28T10:42:31.000Z\",\n * \"_id\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"_updatedDate\": \"2024-02-28T10:42:30.891Z\",\n * \"activityStatus\": \"UNKNOWN\",\n * \"contactId\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"privacyStatus\": \"UNKNOWN\",\n * \"profile\": {\n * \"nickname\": \"johnjonas\",\n * \"slug\": \"johnjonas\"\n * },\n * \"status\": \"UNKNOWN\"\n * }\n */"},{"title":"Get a member by ID with all parameters (export from backend code)","content":"import { members } from 'wix-members.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\n/*\n * Sample _id value: '60a91ab6-5e30-4af2-9d5e-a205c351ffd7'\n *\n * Sample options value:\n * {\n * fieldsets: [ 'FULL' ]\n * }\n */\n\nconst elevatedgetMember = elevate(members.getMember); \n\nexport const myGetMemberFunction = webMethod(\n Permissions.Anyone,\n async (_id, options) => {\n try {\n const member = await elevatedgetMember(_id, options);\n console.log('Member retrieved:', member);\n\n return member;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2024-02-28T10:42:31.000Z\",\n * \"_id\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"_updatedDate\": \"2024-02-28T10:42:30.891Z\",\n * \"activityStatus\": \"UNKNOWN\",\n * \"contactId\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"privacyStatus\": \"UNKNOWN\",\n * \"profile\": {\n * \"nickname\": \"johnjonas\",\n * \"slug\": \"johnjonas\"\n * },\n * \"status\": \"UNKNOWN\"\n * }\n */\n"},{"title":"Get a member by ID (dashboard page code)","content":"import { members } from 'wix-members.v2';\n\n/* Sample _id value: '60a91ab6-5e30-4af2-9d5e-a205c351ffd7' */\n\nexport async function myGetMemberFunction(_id, options){\n try {\n const member = await members.getMember(_id, options);\n console.log('Member retrieved:', member);\n\n return member;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n};\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2024-02-28T10:42:31.000Z\",\n * \"_id\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"_updatedDate\": \"2024-02-28T10:42:30.891Z\",\n * \"activityStatus\": \"UNKNOWN\",\n * \"contactId\": \"20aca292-e791-45b4-902f-7e7e22c96dd5\",\n * \"privacyStatus\": \"UNKNOWN\",\n * \"profile\": {\n * \"nickname\": \"johnjonas\",\n * \"slug\": \"johnjonas\"\n * },\n * \"status\": \"UNKNOWN\"\n * }\n */"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GetMemberOptions","referenceFqn":"GetMemberOptions"},"description":"Fieldset options."}],"description":"Retrieves a member by ID.\n\n>**Note:** The returned Member object contains only the fields that were explicitly added to the Member object. Custom Contact fields are **not** automatically added to the Member object. They must be [added to the Member object by the site owner](https://support.wix.com/en/article/site-members-customizing-your-member-profile-fields).","permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Members","scopeId":"SCOPE.DC-MEMBERS.MANAGE-MEMBERS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Read Members","scopeId":"SCOPE.DC-MEMBERS.READ-MEMBERS"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"isAdminMethod":false},{"name":"joinCommunity","fqn":"joinCommunity","slug":"join-community","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","permissionIds":["MEMBERS.MEMBER_JOIN_COMMUNITY"],"applicableIdentities":["MEMBER"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"JoinCommunityResponse","referenceFqn":"JoinCommunityResponse"},"description":"Member profile."},"examples":[{"title":"Make currently logged-in member's profile public (export from backend code)","content":"import { members } from 'wix-members.v2';\nimport { webMethod, Permissions } from 'wix-web-module'; \n\nexport const myJoinCommunityFunction = webMethod(\n Permissions.Anyone,\n async () => {\n try {\n const member = await members.joinCommunity();\n console.log('Joined site community:', member);\n\n return member;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n\n/* Promise resolves to:\n * {\n * \"member\": {\n * \"createdDate\": \"2024-02-22T13:52:00Z\",\n * \"id\": \"7d368843-6f0c-4037-8d0e-b7e36a8a0c32\",\n * \"updatedDate\": \"2024-02-22T13:52:00.674Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contact\": {\n * \"contactId\": \"ff20c02e-3d13-4412-9529-d628aa0abc12\",\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"phones\": [],\n * \"emails\": [],\n * \"addresses\": [],\n * \"customFields\": {}\n * },\n * \"contactId\": \"ff20c02e-3d13-4412-9529-d628aa0abc12\",\n * \"lastLoginDate\": \"2024-02-29T11:40:21Z\",\n * \"loginEmail\": \"johndoe@example.com\",\n * \"loginEmailVerified\": true,\n * \"privacyStatus\": \"PUBLIC\",\n * \"profile\": {\n * \"nickname\": \"John Doe\",\n * \"slug\": \"johndoe\",\n * \"photo\": {\n * \"id\": \"\",\n * \"url\": \"https://example.com/newphoto.jpg\",\n * \"height\": 0,\n * \"width\": 0\n * }\n * },\n * \"status\": \"APPROVED\"\n * }\n * }\n */"},{"title":"Make the currently logged-in member's profile public (Dashboard page code)","content":"import { members } from 'wix-members.v2';\n\nexport async function myJoinCommunityFunction(){\n try {\n const member = await members.joinCommunity();\n console.log('Joined site community:', member);\n\n return member;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * {\n * \"_id\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"_createdDate\": \"2021-08-02T23:14:42.000Z\",\n * \"_updatedDate\": \"2021-08-02T23:14:58.345Z\",\n * \"lastLoginDate\": \"2021-08-04T11:02:44.000Z\",\n * \"contactId\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"loginEmail\": \"claude.morales@example.com\",\n * \"loginEmailVerified\": true,\n * \"status\": \"APPROVED\",\n * \"privacyStatus\": \"PUBLIC\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contact\": {\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 * \"_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 * \"profile\": {\n * \"nickname\": \"Claude Morales\",\n * \"slug\": \"claudemorales\"\n * }\n * }\n */"}],"description":"Joins the currently logged-in member to the site community and sets their profile to public.\n\nWhen a member's profile is public, they have access to the site's\n[Members Area](https://support.wix.com/en/article/about-members-area)\nfeatures — such as chat, forum, and followers —\nand their profile is visible to other members and site visitors.\n\n> **Note:**\n> Only logged-in members can call this function without elevated permissions.\n> To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.","permissionScopes":[],"isAdminMethod":false},{"name":"leaveCommunity","fqn":"leaveCommunity","slug":"leave-community","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","permissionIds":["MEMBERS.MEMBER_JOIN_COMMUNITY"],"applicableIdentities":["MEMBER"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"LeaveCommunityResponse","referenceFqn":"LeaveCommunityResponse"},"description":"Member profile."},"examples":[{"title":"Make the currently logged-in member's profile private (export from backend code)","content":"import { members } from 'wix-members.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\n\nexport const myLeaveCommunityFunction = webMethod(\n Permissions.SiteMember,\n async () => {\n try {\n const member = await members.joinCommunity();\n console.log('Member removed from site community:', member);\n\n return member;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n\n/* Promise resolves to:\n * {\n * \"member\": {\n * \"createdDate\": \"2024-02-22T13:52:00Z\",\n * \"id\": \"7d368843-6f0c-4037-8d0e-b7e36a8a0c32\",\n * \"updatedDate\": \"2024-02-22T13:52:00.674Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contact\": {\n * \"contactId\": \"ff20c02e-3d13-4412-9529-d628aa0abc12\",\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"phones\": [],\n * \"emails\": [],\n * \"addresses\": [],\n * \"customFields\": {}\n * },\n * \"contactId\": \"ff20c02e-3d13-4412-9529-d628aa0abc12\",\n * \"lastLoginDate\": \"2024-02-29T11:40:21Z\",\n * \"loginEmail\": \"johndoe@example.com\",\n * \"loginEmailVerified\": true,\n * \"privacyStatus\": \"PUBLIC\",\n * \"profile\": {\n * \"nickname\": \"John Doe\",\n * \"slug\": \"johndoe\",\n * \"photo\": {\n * \"id\": \"\",\n * \"url\": \"https://example.com/newphoto.jpg\",\n * \"height\": 0,\n * \"width\": 0\n * }\n * },\n * \"status\": \"APPROVED\"\n * }\n * }\n */"},{"title":"Make the currently logged-in member's profile private (dashboard page code)","content":"import { members } from 'wix-members.v2';\n\nexport async function myLeaveCommunityFunction(){\n try {\n const member = await members.joinCommunity();\n console.log('Member removed from site community:', member);\n\n return member;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n};\n\n/* Promise resolves to:\n * {\n * \"member\": {\n * \"createdDate\": \"2024-02-22T13:52:00Z\",\n * \"id\": \"7d368843-6f0c-4037-8d0e-b7e36a8a0c32\",\n * \"updatedDate\": \"2024-02-22T13:52:00.674Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contact\": {\n * \"contactId\": \"ff20c02e-3d13-4412-9529-d628aa0abc12\",\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"phones\": [],\n * \"emails\": [],\n * \"addresses\": [],\n * \"customFields\": {}\n * },\n * \"contactId\": \"ff20c02e-3d13-4412-9529-d628aa0abc12\",\n * \"lastLoginDate\": \"2024-02-29T11:40:21Z\",\n * \"loginEmail\": \"johndoe@example.com\",\n * \"loginEmailVerified\": true,\n * \"privacyStatus\": \"PUBLIC\",\n * \"profile\": {\n * \"nickname\": \"John Doe\",\n * \"slug\": \"johndoe\",\n * \"photo\": {\n * \"id\": \"\",\n * \"url\": \"https://example.com/newphoto.jpg\",\n * \"height\": 0,\n * \"width\": 0\n * }\n * },\n * \"status\": \"APPROVED\"\n * }\n * }\n */"}],"description":"Removes the currently logged-in member from the site community and sets their profile to private.\n\nWhen a member's profile is private,\nthey do not have access to the site's\n[Members Area](https://support.wix.com/en/article/about-members-area)\nfeatures — such as chat, forum, and followers —\nand their profile is hidden from other members and site visitors.\n\n> **Notes:**\n> + If a member leaves the site's community, their content (such as forum posts and blog comments) remain publicly visible.\n\n> + Only logged-in members can call this function without elevated permissions.\n> + To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.","permissionScopes":[],"isAdminMethod":false},{"name":"listMembers","fqn":"listMembers","slug":"list-members","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","permissionIds":["MEMBERS.MEMBER_READ"],"permissions":["Manage Members","Manage Bookings Services and Settings","Manage Portfolio","Read Members and Contacts - all read permissions","Manage Restaurants - all permissions","Read Members","Manage Members and Contacts - all permissions"],"permissionsScopesIds":["SCOPE.DC-MEMBERS.MANAGE-MEMBERS","SCOPE.BOOKINGS.CONFIGURATION","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS","SCOPE.RESTAURANTS.MEGA-SCOPES","SCOPE.DC-MEMBERS.READ-MEMBERS","SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ListMembersResponse","referenceFqn":"ListMembersResponse"}},"examples":[{"title":"List all site members with full parameters (export from backend code)","content":"import { members } from 'wix-members.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\n\n/* Sample parameter values:\n *\n * {\n * \"options\": {\n * \"fieldsets\": [\"EXTENDED\"],\n * \"paging\": {\n * \"limit\": 20,\n * \"offset\": 0\n * },\n * \"sorting\": [\n * {\n * \"fieldName\": \"lastName\",\n * \"order\": \"ASC\"\n * }\n * ]\n * }\n * }\n */\n\nexport const myListMemberFunction = webMethod(\n Permissions.Anyone,\n async (options) => {\n try {\n const memberList = await members.listMembers(options);\n console.log('Site members:', memberList);\n\n return memberList;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n\n/* Promise resolves to:\n *\n * {\n * \"members\": [\n * {\n * \"_createdDate\": \"2024-02-29T11:12:57.000Z\",\n * \"_id\": \"29ae2752-73d2-4a07-8cba-677e1928ed52\",\n * \"_updatedDate\": \"2024-02-29T11:12:57.474Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contactId\": \"a2b3c4d5-1234-5678-9876-abcdef123456\",\n * \"profile\": {\n * \"nickname\": \"member1\",\n * \"slug\": \"member1_1234\"\n * },\n * \"privacyStatus\": \"PUBLIC\",\n * \"status\": \"VERIFIED\"\n * },\n * {\n * \"_createdDate\": \"2024-02-29T11:12:57.000Z\",\n * \"_id\": \"29ae2752-73d2-4a07-8cba-677e1928ed53\",\n * \"_updatedDate\": \"2024-02-29T11:12:57.474Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contactId\": \"a2b3c4d5-1234-5678-9876-abcdef123457\",\n * \"profile\": {\n * \"nickname\": \"member2\",\n * \"slug\": \"member2_5678\"\n * },\n * \"privacyStatus\": \"PUBLIC\",\n * \"status\": \"VERIFIED\"\n * },\n * {\n * \"_createdDate\": \"2024-02-29T11:12:57.000Z\",\n * \"_id\": \"29ae2752-73d2-4a07-8cba-677e1928ed54\",\n * \"_updatedDate\": \"2024-02-29T11:12:57.474Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contactId\": \"a2b3c4d5-1234-5678-9876-abcdef123458\",\n * \"profile\": {\n * \"nickname\": \"member3\",\n * \"slug\": \"member3_9012\"\n * },\n * \"privacyStatus\": \"PUBLIC\",\n * \"status\": \"VERIFIED\"\n * },\n * {\n * \"_createdDate\": \"2024-02-29T11:12:57.000Z\",\n * \"_id\": \"29ae2752-73d2-4a07-8cba-677e1928ed55\",\n * \"_updatedDate\": \"2024-02-29T11:12:57.474Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contactId\": \"a2b3c4d5-1234-5678-9876-abcdef123459\",\n * \"profile\": {\n * \"nickname\": \"member4\",\n * \"slug\": \"member4_3456\"\n * },\n * \"privacyStatus\": \"PUBLIC\",\n * \"status\": \"VERIFIED\"\n * }\n * ],\n * \"metadata\": {\n * \"count\": 4,\n * \"offset\": 0,\n * \"total\": 4,\n * \"tooManyToCount\": false\n * }\n * }\n */"},{"title":"List site members with no options parameters (export from backend code)","content":"import { members } from 'wix-members.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\n\n/* Sample options value\n *\n * {\n * \"options\": null\n * }\n */\n\nexport const myListMemberFunction = webMethod(\n Permissions.Anyone,\n async (options) => {\n try {\n const memberList = await members.listMembers(options);\n console.log('Site members:', memberList);\n\n return memberList;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n\n/* Promise resolves to:\n *\n * {\n * \"members\": [\n * {\n * \"_createdDate\": \"2024-02-29T11:12:57.000Z\",\n * \"_id\": \"29ae2752-73d2-4a07-8cba-677e1928ed52\",\n * \"_updatedDate\": \"2024-02-29T11:12:57.474Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contactId\": \"a2b3c4d5-1234-5678-9876-abcdef123456\",\n * \"profile\": {\n * \"nickname\": \"member1\",\n * \"slug\": \"member1_1234\"\n * },\n * \"privacyStatus\": \"PUBLIC\",\n * \"status\": \"VERIFIED\"\n * },\n * {\n * \"_createdDate\": \"2024-02-29T11:12:57.000Z\",\n * \"_id\": \"29ae2752-73d2-4a07-8cba-677e1928ed53\",\n * \"_updatedDate\": \"2024-02-29T11:12:57.474Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contactId\": \"a2b3c4d5-1234-5678-9876-abcdef123457\",\n * \"profile\": {\n * \"nickname\": \"member2\",\n * \"slug\": \"member2_5678\"\n * },\n * \"privacyStatus\": \"PUBLIC\",\n * \"status\": \"VERIFIED\"\n * },\n * {\n * \"_createdDate\": \"2024-02-29T11:12:57.000Z\",\n * \"_id\": \"29ae2752-73d2-4a07-8cba-677e1928ed54\",\n * \"_updatedDate\": \"2024-02-29T11:12:57.474Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contactId\": \"a2b3c4d5-1234-5678-9876-abcdef123458\",\n * \"profile\": {\n * \"nickname\": \"member3\",\n * \"slug\": \"member3_9012\"\n * },\n * \"privacyStatus\": \"PUBLIC\",\n * \"status\": \"VERIFIED\"\n * },\n * {\n * \"_createdDate\": \"2024-02-29T11:12:57.000Z\",\n * \"_id\": \"29ae2752-73d2-4a07-8cba-677e1928ed55\",\n * \"_updatedDate\": \"2024-02-29T11:12:57.474Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contactId\": \"a2b3c4d5-1234-5678-9876-abcdef123459\",\n * \"profile\": {\n * \"nickname\": \"member4\",\n * \"slug\": \"member4_3456\"\n * },\n * \"privacyStatus\": \"PUBLIC\",\n * \"status\": \"VERIFIED\"\n * }\n * ],\n * \"metadata\": {\n * \"count\": 4,\n * \"offset\": 0,\n * \"total\": 4,\n * \"tooManyToCount\": false\n * }\n * }\n */"},{"title":"List site members (dashboard page code)","content":"import { members } from 'wix-members.v2';\n\n/* Sample options value\n *\n * {\n * \"options\": null\n * }\n */\n\nexport async function myListMemberFunction(options){\n try {\n const memberList = await members.listMembers(options);\n console.log('Site members:', memberList);\n\n return memberList;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n};\n\n/* Promise resolves to:\n *\n * {\n * \"members\": [\n * {\n * \"_createdDate\": \"2024-02-29T11:12:57.000Z\",\n * \"_id\": \"29ae2752-73d2-4a07-8cba-677e1928ed52\",\n * \"_updatedDate\": \"2024-02-29T11:12:57.474Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contactId\": \"a2b3c4d5-1234-5678-9876-abcdef123456\",\n * \"profile\": {\n * \"nickname\": \"member1\",\n * \"slug\": \"member1_1234\"\n * },\n * \"privacyStatus\": \"PUBLIC\",\n * \"status\": \"VERIFIED\"\n * },\n * {\n * \"_createdDate\": \"2024-02-29T11:12:57.000Z\",\n * \"_id\": \"29ae2752-73d2-4a07-8cba-677e1928ed53\",\n * \"_updatedDate\": \"2024-02-29T11:12:57.474Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contactId\": \"a2b3c4d5-1234-5678-9876-abcdef123457\",\n * \"profile\": {\n * \"nickname\": \"member2\",\n * \"slug\": \"member2_5678\"\n * },\n * \"privacyStatus\": \"PUBLIC\",\n * \"status\": \"VERIFIED\"\n * },\n * {\n * \"_createdDate\": \"2024-02-29T11:12:57.000Z\",\n * \"_id\": \"29ae2752-73d2-4a07-8cba-677e1928ed54\",\n * \"_updatedDate\": \"2024-02-29T11:12:57.474Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contactId\": \"a2b3c4d5-1234-5678-9876-abcdef123458\",\n * \"profile\": {\n * \"nickname\": \"member3\",\n * \"slug\": \"member3_9012\"\n * },\n * \"privacyStatus\": \"PUBLIC\",\n * \"status\": \"VERIFIED\"\n * },\n * {\n * \"_createdDate\": \"2024-02-29T11:12:57.000Z\",\n * \"_id\": \"29ae2752-73d2-4a07-8cba-677e1928ed55\",\n * \"_updatedDate\": \"2024-02-29T11:12:57.474Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contactId\": \"a2b3c4d5-1234-5678-9876-abcdef123459\",\n * \"profile\": {\n * \"nickname\": \"member4\",\n * \"slug\": \"member4_3456\"\n * },\n * \"privacyStatus\": \"PUBLIC\",\n * \"status\": \"VERIFIED\"\n * }\n * ],\n * \"metadata\": {\n * \"count\": 4,\n * \"offset\": 0,\n * \"total\": 4,\n * \"tooManyToCount\": false\n * }\n * }\n */"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ListMembersOptions","referenceFqn":"ListMembersOptions"},"description":"Options for paging, sorting, and specifying fields to return."}],"description":"Lists site members, given the provided paging and fieldsets.\n\n- `PUBLIC` fieldset returns `id` and `profile` object. `status`, `privacyStatus` and `activityStatus` are returned as `UNKNOWN`.\n- `FULL` fieldset returns all fields.","permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Members","scopeId":"SCOPE.DC-MEMBERS.MANAGE-MEMBERS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Read Members","scopeId":"SCOPE.DC-MEMBERS.READ-MEMBERS"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"isAdminMethod":false},{"name":"queryMembers","fqn":"queryMembers","slug":"query-members","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","permissionIds":["MEMBERS.MEMBER_READ"],"permissions":["Manage Members","Manage Bookings Services and Settings","Manage Portfolio","Read Members and Contacts - all read permissions","Manage Restaurants - all permissions","Read Members","Manage Members and Contacts - all permissions"],"permissionsScopesIds":["SCOPE.DC-MEMBERS.MANAGE-MEMBERS","SCOPE.BOOKINGS.CONFIGURATION","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS","SCOPE.RESTAURANTS.MEGA-SCOPES","SCOPE.DC-MEMBERS.READ-MEMBERS","SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"MembersQueryBuilder","referenceFqn":"MembersQueryBuilder"},"examples":[{"title":"Query member's with all option parameters (export from backend code)","content":"import { members } from 'wix-members.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\n\n/* Sample parameter values\n * {\n * \"options\": {\n * \"fieldsets\": [\"EXTENDED\"],\n * \"search\": {\n * \"expression\": \"John Doe\"\n * },\n * \"fields\": [\n * \"loginEmail\",\n * \"contact.firstName\",\n * \"contact.lastName\",\n * \"profile.title\",\n * \"profile.nickname\",\n * \"profile.slug\"\n * ]\n * }\n * }\n */\n\nexport const myQueryMembersFunction = webMethod(\n Permissions.Anyone,\n async (options) => {\n try {\n const siteMembers = await members.queryMembers(options).find();\n console.log('Retrieved members:', siteMembers);\n\n return siteMembers;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n\n/* Promise resolves to:\n * {\n * \"_items\": [\n * {\n * \"loginEmail\": \"newmember1@example.com\",\n * \"loginEmailVerified\": false,\n * \"status\": \"APPROVED\",\n * \"contactId\": \"bbfa3373-9bc0-4479-9766-40e9ff4b6661\",\n * \"contact\": {\n * \"contactId\": \"bbfa3373-9bc0-4479-9766-40e9ff4b6661\",\n * \"phones\": [],\n * \"emails\": [],\n * \"addresses\": [],\n * \"customFields\": {}\n * },\n * \"profile\": {\n * \"nickname\": \"John Doe\",\n * \"slug\": \"newmember1\"\n * },\n * \"privacyStatus\": \"PUBLIC\",\n * \"activityStatus\": \"ACTIVE\",\n * \"_id\": \"bbfa3373-9bc0-4479-9766-40e9ff4b6661\",\n * \"_createdDate\": \"2024-03-01T13:12:43.000Z\",\n * \"_updatedDate\": \"2024-03-01T13:12:43.459Z\"\n * }\n * ],\n * \"_originQuery\": {\n * \"filterTree\": {\n * \"$and\": []\n * },\n * \"invalidArguments\": [],\n * \"encoder\": {},\n * \"transformationPaths\": {},\n * \"sort\": [],\n * \"paging\": {},\n * \"pagingMethod\": \"OFFSET\",\n * \"builderOptions\": {\n * \"cursorWithEmptyFilterAndSort\": true\n * }\n * },\n * \"_limit\": 50,\n * \"_totalCount\": 1,\n * \"_offset\": 0,\n * \"_tooManyToCount\": false\n * }\n */ "}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"QueryMembersOptions","referenceFqn":"QueryMembersOptions"},"description":"Query options."}],"description":"Retrieves a list of up to 100 members, given the provided filters, fieldsets, sorting and paging, and returns a `MembersQueryBuilder` object.\n\nThe returned object contains the query definition which is typically used to run the query using the `find()` function.\n\nYou can refine the query by chaining `MembersQueryBuilder` functions onto the query. `MembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMembers()` returns. The functions that are chained to `queryMembers()` are applied in the order they are called. \n\n`queryMembers()` runs with the following `MembersQueryBuilder` defaults that you can override:\n- `skip`: `0`\n- `limit`: `50`\n\nCurrently supported fields for sorting: \n- `profile.nickname`\n- `contact.firstName`\n- `contact.lastName`\n- `createdDate`\n- `lastLoginDate`\n\nThe following `MembersQueryBuilder` functions are supported for the `queryMembers()` function. For a full description of the Locations object, see the returned for the `items` property in `MembersQueryResult`. \n\n\n|PROPERTY\t|SUPPORTED FILTERS & SORTING\t\n|:---:|:---:|\n|`_id`|[`eq()`](/members/members-query-builder/eq),[`ne()`](/members/members-query-builder/ne),[`exists()`](/members/members-query-builder/exists),[`in()`](/members/members-query-builder/in),[`hasSome()`](/members/members-query-builder/has-some),[`startsWith()`](/members/members-query-builder/starts-with)|\n|`loginEmail`|[`eq()`](/members/members-query-builder/eq),[`ne()`](/members/members-query-builder/ne),[`exists()`](/members/members-query-builder/exists),[`in()`](/members/members-query-builder/in),[`hasSome()`](/members/members-query-builder/has-some),[`startsWith()`](/members/members-query-builder/starts-with)|\n|`contact.firstName`|[`eq()`](/members/members-query-builder/eq),[`ne()`](/members/members-query-builder/ne),[`exists()`](/members/members-query-builder/exists),[`in()`](/members/members-query-builder/in),[`hasSome()`](/members/members-query-builder/has-some),[`startsWith()`](/members/members-query-builder/starts-with)|\n|`contact.lastName`|[`eq()`](/members/members-query-builder/eq),[`ne()`](/members/members-query-builder/ne),[`exists()`](/members/members-query-builder/exists),[`in()`](/members/members-query-builder/in),[`hasSome()`](/members/members-query-builder/has-some),[`startsWith()`](/members/members-query-builder/starts-with)|\n|`profile.nickname`|[`eq()`](/members/members-query-builder/eq),[`ne()`](/members/members-query-builder/ne),[`exists()`](/members/members-query-builder/exists),[`in()`](/members/members-query-builder/in),[`hasSome()`](/members/members-query-builder/has-some),[`startsWith()`](/members/members-query-builder/starts-with)|\n|`profile.slug`|[`eq()`](/members/members-query-builder/eq),[`ne()`](/members/members-query-builder/ne),[`exists()`](/members/members-query-builder/exists),[`in()`](/members/members-query-builder/in),[`hasSome()`](/members/members-query-builder/has-some),[`startsWith()`](/members/members-query-builder/starts-with)|\n|`privacyStatus`|[`eq()`](/members/members-query-builder/eq),[`ne()`](/members/members-query-builder/ne),[`exists()`](/members/members-query-builder/exists),[`in()`](/members/members-query-builder/in),[`hasSome()`](/members/members-query-builder/has-some)|","permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Members","scopeId":"SCOPE.DC-MEMBERS.MANAGE-MEMBERS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Read Members","scopeId":"SCOPE.DC-MEMBERS.READ-MEMBERS"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"isAdminMethod":false},{"name":"updateCurrentMemberSlug","fqn":"updateCurrentMemberSlug","slug":"update-current-member-slug","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["slug"],"permissionIds":["MEMBERS.MEMBER_UPDATE"],"permissions":["Manage Members","Manage Bookings Services and Settings","Manage Portfolio","Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.DC-MEMBERS.MANAGE-MEMBERS","SCOPE.BOOKINGS.CONFIGURATION","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP","MEMBER"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"UpdateMySlugResponse","referenceFqn":"UpdateMySlugResponse"}},"examples":[{"title":"Update the currently logged-in member's slug (export from backend code)","content":"import { members } from 'wix-members.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\n\nconst updateCurrentMemberSlug = members.updateCurrentMemberSlug;\n\n/* Sample slug value:\n * {\n * \"slug\": \"new-member-slug\"\n * }\n */\n\nexport const myUpdateCurrentMemberSlugFunction = webMethod(\n Permissions.SiteMember,\n async (slug) => {\n try {\n const member = await updateCurrentMemberSlug(slug);\n const memberID = members._id;\n \n console.log('Updated slug:', member);\n\n return member;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2024-02-22T13:52:00.000Z\",\n * \"_id\": \"7d368843-6f0c-4037-8d0e-b7e36a8a0c32\",\n * \"_updatedDate\": \"2024-02-22T13:52:00.674Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contact\": {\n * \"contactId\": \"ff20c02e-3d13-4412-9529-d628aa0abc12\",\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"phones\": [],\n * \"emails\": [\n * \"john.doe@example.com\"\n * ],\n * \"addresses\": [],\n * \"customFields\": {}\n * },\n * \"contactId\": \"ff20c02e-3d13-4412-9529-d628aa0abc12\",\n * \"lastLoginDate\": \"2024-02-29T11:40:21.000Z\",\n * \"loginEmail\": \"john.doe@example.com\",\n * \"loginEmailVerified\": true,\n * \"privacyStatus\": \"PUBLIC\",\n * \"profile\": {\n * \"nickname\": \"JohnD\",\n * \"slug\": \"new-member-slug\",\n * \"photo\": {\n * \"url\": \"https://example.com/new_photo.jpg\",\n * \"height\": 0,\n * \"width\": 0,\n * \"_id\": \"\"\n * }\n * },\n * \"status\": \"APPROVED\"\n * }\n */ "},{"title":"Update the currently logged-in member's slug (Dashboard page code)","content":"import { members } from 'wix-members.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\n\nconst updateCurrentMemberSlug = members.updateCurrentMemberSlug;\n\n/* Sample slug value:\n * {\n * \"slug\": \"new-member-slug\"\n * }\n */\n\nexport async function myUpdateCurrentMemberSlugFunction(slug){\n try {\n const member = await updateCurrentMemberSlug(slug);\n console.log('Updated slug:', member);\n \n return member;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n};\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2024-02-22T13:52:00.000Z\",\n * \"_id\": \"7d368843-6f0c-4037-8d0e-b7e36a8a0c32\",\n * \"_updatedDate\": \"2024-02-22T13:52:00.674Z\",\n * \"activityStatus\": \"ACTIVE\",\n * \"contact\": {\n * \"contactId\": \"ff20c02e-3d13-4412-9529-d628aa0abc12\",\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"phones\": [],\n * \"emails\": [\n * \"john.doe@example.com\"\n * ],\n * \"addresses\": [],\n * \"customFields\": {}\n * },\n * \"contactId\": \"ff20c02e-3d13-4412-9529-d628aa0abc12\",\n * \"lastLoginDate\": \"2024-02-29T11:40:21.000Z\",\n * \"loginEmail\": \"john.doe@example.com\",\n * \"loginEmailVerified\": true,\n * \"privacyStatus\": \"PUBLIC\",\n * \"profile\": {\n * \"nickname\": \"JohnD\",\n * \"slug\": \"new-member-slug\",\n * \"photo\": {\n * \"url\": \"https://example.com/new_photo.jpg\",\n * \"height\": 0,\n * \"width\": 0,\n * \"_id\": \"\"\n * }\n * },\n * \"status\": \"APPROVED\"\n * }\n */ "}],"actionParams":[{"name":"slug","slug":"slug","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"New slug."}],"description":"Updates the currently logged in member's slug.\n\nThe `slug` is the end of a member's URL that refers to a specific logged-in member. For example, if a member's URL is `https://example.com/member/{my-member-slug}`, the slug is `my-member-slug`. The slug is case-sensitive and is generally derived from the member's `nickname`; otherwise, it's derived from the `loginEmail`.\n\n> **Note:**\n> Only logged-in members can call this function without elevated permissions.\n> To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.","permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Members","scopeId":"SCOPE.DC-MEMBERS.MANAGE-MEMBERS"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":false},{"name":"updateMember","fqn":"updateMember","slug":"update-member","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["_id","member"],"permissionIds":["MEMBERS.MEMBER_UPDATE"],"permissions":["Manage Members","Manage Bookings Services and Settings","Manage Portfolio","Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.DC-MEMBERS.MANAGE-MEMBERS","SCOPE.BOOKINGS.CONFIGURATION","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP","MEMBER"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Member","referenceFqn":"Member"}},"examples":[{"title":"Update a member's email addresses (export from backend code)","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { members } from 'wix-members.v2';\n\n/* Sample _id value: 'f32cbc51-a331-442b-86c2-2c664613e8b9'\n *\n * Sample member value:\n * {\n * contact: {\n * emails: ['claudes.new.email@example.com']\n * }\n * }\n *\n */\n\nexport const myUpdateMemberFunction = webMethod(\n Permissions.Anyone, (id, member) => {\n return members.updateMember(id, member)\n .then((member) => {\n return member;\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/* Promise resolves to:\n * {\n * \"_id\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"_createdDate\": \"2021-08-02T23:14:42.000Z\",\n * \"_updatedDate\": \"2021-08-02T23:14:58.345Z\",\n * \"contactId\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"activityStatus\": \"UNKNOWN\",\n * \"privacyStatus\": \"UNKNOWN\",\n * \"status\": \"UNKNOWN\",\n * \"contact\": {\n * \"firstName\": \"Claude\",\n * \"lastName\": \"Morales\",\n * \"phones\": [\n * \"0747-769-460\"\n * ],\n * \"emails\": [\n * \"claudes.new.email@example.com\"\n * ],\n * \"addresses\": [\n * {\n * \"_id\": \"e151960c-04a7-43ef-aa17-a134916ded07\",\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 * \"_id\": \"88a6f2ed-83d5-435d-ab55-4af1cb1b7861\",\n * \"country\": \"IE\"\n * }\n * ],\n * \"customFields\": {\n * \"someKey\": {\n * \"value\": \"someValue\"\n * }\n * }\n * },\n * \"profile\": {\n * \"nickname\": \"Claude Morales\",\n * \"slug\": \"claudemorales\"\n * }\n * }\n*/"},{"title":"Update a member's email addresses (Dashboard page code)","content":"import { members } from 'wix-members.v2';\n\n/* Sample _id value: 'f32cbc51-a331-442b-86c2-2c664613e8b9'\n *\n * Sample member value:\n * {\n * contact: {\n * emails: ['claudes.new.email@example.com']\n * }\n * }\n *\n */\n\nexport async function myUpdateMemberFunction(_id, member){\n try {\n const updatedMember = members.updateMember(_id, member);\n console.log('Successfully updated member!', member);\n } catch (error) {\n console.error(error)\n // Handle the error\n }\n};\n\n/* Promise resolves to:\n * {\n * \"_id\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"_createdDate\": \"2021-08-02T23:14:42.000Z\",\n * \"_updatedDate\": \"2021-08-02T23:14:58.345Z\",\n * \"contactId\": \"f32cbc51-a331-442b-86c2-2c664613e8b9\",\n * \"activityStatus\": \"UNKNOWN\",\n * \"privacyStatus\": \"UNKNOWN\",\n * \"status\": \"UNKNOWN\",\n * \"contact\": {\n * \"firstName\": \"Claude\",\n * \"lastName\": \"Morales\",\n * \"phones\": [\n * \"0747-769-460\"\n * ],\n * \"emails\": [\n * \"claudes.new.email@example.com\"\n * ],\n * \"addresses\": [\n * {\n * \"_id\": \"e151960c-04a7-43ef-aa17-a134916ded07\",\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 * \"_id\": \"88a6f2ed-83d5-435d-ab55-4af1cb1b7861\",\n * \"country\": \"IE\"\n * }\n * ],\n * \"customFields\": {\n * \"someKey\": {\n * \"value\": \"someValue\"\n * }\n * }\n * },\n * \"profile\": {\n * \"nickname\": \"Claude Morales\",\n * \"slug\": \"claudemorales\"\n * }\n * }\n*/"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID."},{"name":"member","slug":"member","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateMember","referenceFqn":"UpdateMember"}}],"description":"Updates a member's properties.\n\nOnly the requested fields are updated.\nTo clear a field's value, set an empty value with an empty string `\"\"`.\n\n> **Note:**\n> Updating the `contact.addresses`, `contact.emails`, or `contact.phones` array overwrites the entire array, so any existing values you want to retain must be passed in the `updateMember()` call along with the new values to add.\n> However, passing an empty array will have no effect, and these functions must be used to clear all data from the respective array:\n>- To clear `contact.addresses`, use `deleteMemberAddresses()`.\n>- To clear `contact.emails`, use `deleteMemberEmails()`.\n>- To clear `contact.phones`, use `deleteMemberPhones()`.\n\n> **Note:**\n> Only logged-in members can call this function without elevated permissions.\n> To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.","permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Members","scopeId":"SCOPE.DC-MEMBERS.MANAGE-MEMBERS"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":false}],"webhooks":[],"articles":[{"content":"---\ntitle: Introduction\n---\n\n# Introduction\n\n \n\n

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

\n\n \n\n> **Note:** This module is [universal](/api-overview/api-versions#universal-modules). Functions in this module can run on both the backend and frontend, unless specified otherwise.\n\n\nThe Members API allows you to create and manage a site's members.\n\nWith the Members API, you can:\n- [Create](wix-members-v2/members/create-member), [update](wix-members-v2/members/update-member), and [delete](wix-members-v2/members/delete-member) site members.\n- [Retrieve](wix-members-v2/members/query-members) member's information from your site.\n- [Add](wix-members-v2/members/join-community) the currently logged in member to your site's community, or [remove](wix-members-v2/members/leave-community) the member from your site's community. \n- [Clear](wix-members-v2/delete-member-address) a member's contact information such as their addresses, phone numbers, and emails. \n\nTo use the Members API, import `{ members }` from the `wix-members.v2` module. \n\n```javascript\nimport { members } from 'wix-members.v2';\n```\n\n## Before you begin\n\nIt’s important to note the following points before starting to code:\n- You must add the Members Area app on your site. \n\n## Permissions information\n\nThe following functions in Members are restricted and only run if you elevate permissions\nusing the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate)\nfunction:\n- [createMember()](wix-members-v2/members/create-member)\n- [deleteMember()](wix-members-v2/members/delete-member)\n\n

\n
\nWarning:\nElevating a function allows it to be called by any site visitor.\nExercise caution to prevent security vulnerabilities.\n
\n

\n\n\n## Terminology\n\n- **Members:** Site visitors who have signed up as members through your site's [Member Signup Form](https://support.wix.com/en/article/about-the-member-signup-form). Members have their own profiles and can interact with other members of the site community.\n- **Site Community:** A platform on your site where members can interact with eachother. ","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[{"kind":"REFERENCE","name":"MembersQueryBuilder","referenceFqn":"MembersQueryBuilder"},{"kind":"REFERENCE","name":"MembersQueryResult","referenceFqn":"MembersQueryResult"}],"properties":[],"namespaces":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.80"}}

getMember( )