Deprecated. This function will continue to work, but a newer version is available at updateMember().
Updates a member's properties.
The updateMember()
function returns a Promise that resolves to a member object
when the specified member is updated.
Note: The updated Member object contains only the fields that were explicity 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.
Only the requested fields are updated.
Note:
Updating the contactDetails.addresses
, contactDetails.emails
, or contactDetails.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.
However, passing an empty array will have no effect, and these functions must be used to clear all data from the respective array:
contactDetails.addresses
, use deleteMemberAddresses()
.contactDetails.emails
, use deleteMemberEmails()
.contactDetails.phones
, use deleteMemberPhones()
.If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to updateMember().
To migrate to the new function:
Add the new import statement:
import { members } from "wix-members.v2";
Test your changes to make sure your code behaves as expected.
function updateMember(id: string, member: MemberInfo): Promise<Member>;
Member ID.
Member details to update.
This example uses a deprecated function.
import { Permissions, webMethod } from "wix-web-module";
import { members } from "wix-members-backend";
// Sample id value:
// 'f32cbc51-a331-442b-86c2-2c664613e8b9'
//
// Sample member value:
// {
// contactDetails: {
// emails: ['claudes.new.email@example.com']
// }
// }
export const myUpdateMemberFunction = webMethod(
Permissions.Anyone,
(id, member) => {
return members
.updateMember(id, member)
.then((member) => {
return member;
})
.catch((error) => {
console.error(error);
});
},
);
/* Promise resolves to:
* {
* "_id": "f32cbc51-a331-442b-86c2-2c664613e8b9",
* "_createdDate": "2021-08-02T23:14:42.000Z",
* "_updatedDate": "2021-08-02T23:14:58.345Z",
* "contactId": "f32cbc51-a331-442b-86c2-2c664613e8b9",
* "activityStatus": "UNKNOWN",
* "privacyStatus": "UNKNOWN",
* "status": "UNKNOWN",
* "contactDetails": {
* "firstName": "Claude",
* "lastName": "Morales",
* "phones": [
* "0747-769-460"
* ],
* "emails": [
* "claudes.new.email@example.com"
* ],
* "addresses": [
* {
* "_id": "e151960c-04a7-43ef-aa17-a134916ded07",
* "addressLine": "9373 Park Avenue",
* "addressLine2": "Berkshire",
* "city": "Ely",
* "subdivision": "GB-ENG",
* "country": "GB",
* "postalCode": "PD50 8EU"
* },
* {
* "_id": "88a6f2ed-83d5-435d-ab55-4af1cb1b7861",
* "country": "IE"
* }
* ],
* "customFields": {
* "someKey": {
* "value": "someValue"
* }
* }
* },
* "profile": {
* "nickname": "Claude Morales",
* "slug": "claudemorales"
* }
* }
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.