Updates a member's properties.
Only the requested fields are updated.
To clear a field's value, set an empty value with an empty string ""
.
Note:
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.
However, passing an empty array will have no effect, and these functions must be used to clear all data from the respective array:
contact.addresses
, use deleteMemberAddresses()
.contact.emails
, use deleteMemberEmails()
.contact.phones
, use deleteMemberPhones()
.Note: Only logged-in members can call this function without elevated permissions. To call this function as a different identity, elevated permissions are required.
function updateMember(_id: string, member: UpdateMember): Promise<Member>;
Member ID.
import { Permissions, webMethod } from "wix-web-module";
import { members } from "wix-members.v2";
/* Sample _id value: 'f32cbc51-a331-442b-86c2-2c664613e8b9'
*
* Sample member value:
* {
* contact: {
* 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",
* "contact": {
* "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.