This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a site member.
After creation, you can use the sendSetPasswordEmail()
function in the Members Authentication API to email the member with a link to set their password.
The member can log in to the site once they set their password for the first time.
Note: When creating multiple members, set your requests at least 1 second apart to keep below rate limits.
This function requires elevated permissions and runs only on the backend and on dashboard pages.
function createMember(options: CreateMemberOptions): Promise<Member>;
import { members } from "wix-members.v2";
import { webMethod, Permissions } from "wix-web-module";
import { elevate } from "wix-auth";
const elevatedCreateMember = elevate(members.createMember);
/* Sample member value:
* {
* "member": {
* "loginEmail": "examplemember@gmail.com",
* "privacyStatus": "PUBLIC"
* }
* }
*/
export const myCreateMemberFunction = webMethod(
Permissions.Anyone,
async (member) => {
try {
const newMember = await elevatedCreateMember(member);
console.log("Created new member:", newMember);
return newMember;
} catch (error) {
console.error(error);
// Handle the error
}
},
);
/* Promise resolves to:
* {
* "_createdDate": "2024-02-29T09:42:31.000Z",
* "_id": "29ae2752-73d2-4a07-8cba-677e1928ed52",
* "_updatedDate": "2024-02-29T09:42:30.857Z",
* "activityStatus": "ACTIVE",
* "contact": {
* "addresses": [],
* "contactId": "29ae2752-73d2-4a07-8cba-677e1928ed52",
* "customFields": {},
* "emails": [],
* "phones": []
* },
* "loginEmail": "examplemember@gmail.com",
* "loginEmailVerified": false,
* "privacyStatus": "PUBLIC",
* "profile": {},
* "status": "APPROVED"
* }
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.