> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # MuteMember # Package: memberManagement # Namespace: Members # Method link: https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/mute-member.md ## Permission Scopes: Manage Members: SCOPE.DC-MEMBERS.MANAGE-MEMBERS ## Introduction Mutes a member. Muted members can't engage with a community. For example, they can't leave comments, like posts or comments, or share content. You can mute members in [Wix Blog](https://dev.wix.com/docs/rest/business-solutions/blog/introduction.md) and [Wix Forum](https://dev.wix.com/docs/rest/business-solutions/forum/introduction.md). To unmute a member, call [Unmute Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/unmute-member.md). --- ## REST API ### Schema ``` Method: muteMember Description: Mutes a member. Muted members can't engage with a community. For example, they can't leave comments, like posts or comments, or share content. You can mute members in [Wix Blog](https://dev.wix.com/docs/rest/business-solutions/blog/introduction.md) and [Wix Forum](https://dev.wix.com/docs/rest/business-solutions/forum/introduction.md). To unmute a member, call [Unmute Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/unmute-member.md). URL: https://www.wixapis.com/members/v1/members/{id}/mute Method: POST Return type: MuteMemberResponse - name: member | type: Member | description: Muted member. - name: id | type: string | description: Member GUID. - name: loginEmail | type: string | description: Email used by a member to log in to the site. - name: loginEmailVerified | type: boolean | description: Whether the email used by a member has been verified. - name: status | type: Status | description: Member site access status. - enum: - UNKNOWN: Insufficient permissions to get the status. - PENDING: Member is created and is waiting for approval by a Wix user. - APPROVED: Member can log in to the site. - BLOCKED: Member is blocked and can't log in to the site. - OFFLINE: Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-managed-writers-to-your-blog) for the site blog and can't log in to the site. - name: contactId | type: string | description: Contact GUID. - name: contact | type: Contact | description: Member's contact information. Contact information is stored in the [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). The full set of contact data can be accessed and managed with the [Contacts API](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/introduction.md). - name: firstName | type: string | description: Contact's first name. - name: lastName | type: string | description: Contact's last name. - name: phones | type: array | description: List of phone numbers. - name: emails | type: array | description: List of email addresses. - name: addresses | type: array
| description: List of street addresses. - ONE-OF: - name: streetAddress | type: StreetAddress | description: Street address object, with number and name in separate fields. - name: number | type: string | description: Street number. - name: name | type: string | description: Street name. - name: addressLine | type: string | description: Main address line, usually street and number, as free text. - name: id | type: string | description: Street address GUID. - name: addressLine2 | type: string | description: Free text providing more detailed address information, such as apartment, suite, or floor. - name: city | type: string | description: City name. - name: subdivision | type: string | description: Code for a subdivision (such as state, prefecture, or province) in an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. - name: country | type: string | description: 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. - name: postalCode | type: string | description: Postal code. - name: birthdate | type: string | description: Contact's birthdate, formatted as `"YYYY-MM-DD"`. Example: `"2020-03-15"` for March 15, 2020. - name: company | type: string | description: Contact's company name. - name: jobTitle | type: string | description: Contact's job title. - name: customFields | type: Map | description: Custom fields, where each key is the field key, and each value is the field's value for the member. - name: name | type: string | description: Custom field name. - name: value | type: Value | description: Custom field value. - ONE-OF: - name: nullValue | type: | description: - name: numberValue | type: number | description: - name: stringValue | type: string | description: - name: boolValue | type: boolean | description: - name: structValue | type: object | description: - name: listValue | type: ListValue | description: - name: values | type: array | description: - name: profile | type: Profile | description: Profile display details. - name: nickname | type: string | description: Name that identifies the member to other members. Displayed on the member's profile page and interactions in the forum or blog. - name: slug | type: string | description: Slug that determines the member's profile page URL. - name: photo | type: Image | description: Member's profile photo. - name: id | type: string | description: Wix Media image GUID, set when the member selects an image from Wix Media. - name: url | type: string | description: Image URL. - name: height | type: integer | description: Original image width. - name: width | type: integer | description: Original image height. - name: offsetX | type: integer | description: X-axis offset. Default: `0`. - name: offsetY | type: integer | description: Y-axis offset. Default: `0`. - name: cover | type: Image | description: Member's cover photo, used as a background picture in a member's profile page. Cover positioning can be altered with `cover.offsetX` and `cover.offsetY`. When left empty, the values default to `0`. - name: title | type: string | description: Member title. - name: privacyStatus | type: Status | description: Member privacy status. - enum: - UNKNOWN: Insufficient permissions to get the status. - PRIVATE: Member is hidden from site visitors and other site members. Member is returned only to Wix users. - PUBLIC: Member is visible to everyone. - name: activityStatus | type: Status | description: Member activity status. - enum: - UNKNOWN: Insufficient permissions to get the status. - ACTIVE: Member can write forum posts and blog comments. - MUTED: Member can't write forum posts or blog comments. - name: createdDate | type: string | description: Date and time when the member was created. - name: updatedDate | type: string | description: Date and time when the member was updated. - name: lastLoginDate | type: string | description: Date and time when the member last logged in to the site. ``` ### Examples ### MuteMember ```curl ~~~cURL curl -X POST \ https://www.wixapis.com/members/v1/members/e62e3011-55cf-4de3-a497-e097b52d86b7/mute \ -H 'Authorization: ' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.memberManagement.Members.muteMember(_id) Description: Mutes a member. Muted members can't engage with a community. For example, they can't leave comments, like posts or comments, or share content. You can mute members in [Wix Blog](https://dev.wix.com/docs/rest/business-solutions/blog/introduction.md) and [Wix Forum](https://dev.wix.com/docs/rest/business-solutions/forum/introduction.md). To unmute a member, call [Unmute Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/unmute-member.md). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: _id Method parameters: param name: _id | type: string | description: GUID of the member to mute. | required: true Return type: PROMISE - name: member | type: Member | description: Muted member. - name: _id | type: string | description: Member GUID. - name: loginEmail | type: string | description: Email used by a member to log in to the site. - name: loginEmailVerified | type: boolean | description: Whether the email used by a member has been verified. - name: status | type: Status | description: Member site access status. - enum: - UNKNOWN: Insufficient permissions to get the status. - PENDING: Member is created and is waiting for approval by a Wix user. - APPROVED: Member can log in to the site. - BLOCKED: Member is blocked and can't log in to the site. - OFFLINE: Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-managed-writers-to-your-blog) for the site blog and can't log in to the site. - name: contactId | type: string | description: Contact GUID. - name: contact | type: Contact | description: Member's contact information. Contact information is stored in the [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). The full set of contact data can be accessed and managed with the [Contacts API](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/introduction.md). - name: firstName | type: string | description: Contact's first name. - name: lastName | type: string | description: Contact's last name. - name: phones | type: array | description: List of phone numbers. - name: emails | type: array | description: List of email addresses. - name: addresses | type: array
| description: List of street addresses. - ONE-OF: - name: streetAddress | type: StreetAddress | description: Street address object, with number and name in separate fields. - name: number | type: string | description: Street number. - name: name | type: string | description: Street name. - name: addressLine | type: string | description: Main address line, usually street and number, as free text. - name: _id | type: string | description: Street address GUID. - name: addressLine2 | type: string | description: Free text providing more detailed address information, such as apartment, suite, or floor. - name: city | type: string | description: City name. - name: subdivision | type: string | description: Code for a subdivision (such as state, prefecture, or province) in an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. - name: country | type: string | description: 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. - name: postalCode | type: string | description: Postal code. - name: birthdate | type: string | description: Contact's birthdate, formatted as `"YYYY-MM-DD"`. Example: `"2020-03-15"` for March 15, 2020. - name: company | type: string | description: Contact's company name. - name: jobTitle | type: string | description: Contact's job title. - name: customFields | type: Map | description: Custom fields, where each key is the field key, and each value is the field's value for the member. - name: name | type: string | description: Custom field name. - name: value | type: Value | description: Custom field value. - ONE-OF: - name: nullValue | type: | description: - name: numberValue | type: number | description: - name: stringValue | type: string | description: - name: boolValue | type: boolean | description: - name: structValue | type: object | description: - name: listValue | type: ListValue | description: - name: values | type: array | description: - name: profile | type: Profile | description: Profile display details. - name: nickname | type: string | description: Name that identifies the member to other members. Displayed on the member's profile page and interactions in the forum or blog. - name: slug | type: string | description: Slug that determines the member's profile page URL. - name: photo | type: Image | description: Member's profile photo. - name: _id | type: string | description: Wix Media image GUID, set when the member selects an image from Wix Media. - name: url | type: string | description: Image URL. - name: height | type: integer | description: Original image width. - name: width | type: integer | description: Original image height. - name: offsetX | type: integer | description: X-axis offset. Default: `0`. - name: offsetY | type: integer | description: Y-axis offset. Default: `0`. - name: cover | type: Image | description: Member's cover photo, used as a background picture in a member's profile page. Cover positioning can be altered with `cover.offsetX` and `cover.offsetY`. When left empty, the values default to `0`. - name: title | type: string | description: Member title. - name: privacyStatus | type: Status | description: Member privacy status. - enum: - UNKNOWN: Insufficient permissions to get the status. - PRIVATE: Member is hidden from site visitors and other site members. Member is returned only to Wix users. - PUBLIC: Member is visible to everyone. - name: activityStatus | type: Status | description: Member activity status. - enum: - UNKNOWN: Insufficient permissions to get the status. - ACTIVE: Member can write forum posts and blog comments. - MUTED: Member can't write forum posts or blog comments. - name: _createdDate | type: Date | description: Date and time when the member was created. - name: _updatedDate | type: Date | description: Date and time when the member was updated. - name: lastLoginDate | type: Date | description: Date and time when the member last logged in to the site. ``` ### Examples ### muteMember ```javascript import { members } from '@wix/members'; async function muteMember(_id) { const response = await members.muteMember(_id); }; ``` ### muteMember (with elevated permissions) ```javascript import { members } from '@wix/members'; import { auth } from '@wix/essentials'; async function myMuteMemberMethod(_id) { const elevatedMuteMember = auth.elevate(members.muteMember); const response = await elevatedMuteMember(_id); } ``` ### muteMember (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { members } from '@wix/members'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { members }, // Include the auth strategy and host as relevant }); async function muteMember(_id) { const response = await myWixClient.members.muteMember(_id); }; ``` ---