Members is a service that allows Wix site members to create their own profiles on Wix sites. Profiles can be private or public. Private profiles are applicable for stores, bookings. Public profiles are applicable for site communities with forum, blog.
Wix Members allows users to add a personal account area for their site members (UoU) - both for social communities or non social businesses. Members can choose if their account is private or public and set up their profile.
To learn more about Wix Members Area, read this article
Wix members APIs:
- Members (all member's info)
- Following-Followers (member's following and followers list)
- Activity Counters (counter of posts, likes, comments)
- Badges (create Assign and get badges list per member)
Members area is available for the following Wix business solutions:
- Wix Stores (my orders, my addresses, wishlist)
- Wix Bookings (my bookings - upcoming + history)
- Wix Forum (forum posts, forum, comments)
- Wix Blog (my drafts, blog posts, blog comments, blog likes)
- Wix Events (my events - upcoming + history)
- Wix File share (my files)
Members general pages:
- My Account (stores member's private info)
- Profile (stores member's public info)
- Following - Followers
- Settings
- Notifications
- Members list page (site level)
Private member - only the member and the site owner can see this member
Public member - anyone can see this member
Blocked member - the member can not log-in to the site
Muted Member - Member can not do social actions on this site (write posts / like / comment etc)
Pending member - a member that request to join the site and wasn't approved yet
1. Adding an existing loyalty program app for members (business use case - store). A developer wants to add a loyalty program service to his store
He is using a 3rd party app (like smile, swell etc.) in order to offer member's benefits
The required info for integration:
- Member details (id, first name, last name, address)
- Members events (signup, update)
- Activity counters events
- Store orders events
- Member’s status (approved / blocked - loyalty benefits are only for active members)
- Store orders history (from stores API)
- Badges events (getting a badge will give more points)
2. Sending SMS to members who booked services (business use case - bookings). A developer wants to add an SMS service to update members on their bookings
- successful sign-up to class
- booking approved
- available spot on a class they signed to its wait-list
Integrate with 3rd party app that sends SMSs (like vonage)
The required info for integration:
- Member details (id, first name, last name, phone number)
- Bookings API + Events
3. Syncing with an external CRM system (mailchimp, hubspot). A developer wants to sync all of his members data to his own dashboard in order to manage his members information
The required info:
- Sign up event
- Member creation event
- Member details (id, first name, last name, phone number, email)
- Update event (for any information that the member changes)
Wix Members area provides site members with a personal account area for social communities or non-social businesses. Members can choose if their account is private or public and set up their profile.
Blocked - this member can not log-in to the site.
Pending - this member has requested to join the site and is waitng for approval.
Private - this member's data is available only to themselves and the site owner.
Public - this member's data is available to all.
Muted - this member may not perform social actions on this site (write/like/comment on posts, etc.).
Active - this member may perform social actions on this site (write/like/comment on posts, etc.).
Fieldset in query defines how much data the endpoint will return.
PUBLIC - Default fieldSet. Request with this fieldSet value returns: ID and profile object (status, privacyStatus and activityStatus will return with UNKNOWN values).
FULL - Complete data fieldSet. Request with this fieldSet value returns: ID, status, contact object, profile object, privacyStatus, activityStatus, createdDate and updatedDate.
This article shares a possible use cases your app could support, as well as an example flow that could support the use case. You're certainly not limited to the use case, but it can be a helpful jumping off point as you plan your app's implementation.
Your app can create site members without the member signing up directly on the site. This allows site owners to create members in bulk or to import members from another site.
To do this, your app can follow this basic flow:
-
Create the list of members or get the list of members from the external site. Structure the list as an array of member objects, and make sure each member has a login email address:
Copy Code{"member": {"loginEmail": "member_needs_an@email.com","contact": { ... },"profile": { ... }}} -
Iterate over the array, calling Create Member for each member. To keep below rate limits, set your requests at least 1 second apart.
-
To tell the members about their new accounts, use Send Set Password Email (in the Authorization API). Your app can trigger the email immediately after creating the member, or you can let the site owner choose to send the email later. If the email is triggered later, your app should iterate over an array of the member email addresses, calling Send Set Password Email for each email.
- PENDING: Member created and is waiting for approval by site owner.
- APPROVED: Member can log in to the site.
- OFFLINE: Member is a guest author for the site blog and cannot log in to the site.
- BLOCKED: Member is blocked and cannot log in to the site.
- UNKNOWN: Insufficient permissions to get the status.
- PUBLIC: Member is visible to everyone.
- PRIVATE: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
- UNKNOWN: Insufficient permissions to get the status.
- ACTIVE: Member can write forum posts and blog comments.
- MUTED: Member cannot write forum posts or blog comments.
- UNKNOWN: Insufficient permissions to get the status.
Retrieves a member by ID.
PUBLIC
fieldset returnsid
,contactId
, and theprofile
object.status
,privacyStatus
andactivityStatus
are returned asUNKNOWN
.EXTENDED
fieldset returnsid
,loginEmail
,status
,contactId
,privacyStatus
,activityStatus
, and theprofile
object.FULL
fieldset returns all fields.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Deletes a member.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Lists site members, given the provided paging and fieldsets.
PUBLIC
fieldset returnsid
andprofile
object.status
,privacyStatus
andactivityStatus
are returned asUNKNOWN
.FULL
fieldset returns all fields.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Creates a site member.
After creation, you can use Send Set Password Email to email the member with a link to set their password. The member can log in to the site when 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.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Retrieves a list of up to 100 members, given the provided filters, fieldsets, sorting and paging.
PUBLIC
fieldset returnsid
andprofile
object.status
,privacyStatus
andactivityStatus
are returned asUNKNOWN
.FULL
fieldset returns all fields.
Currently supported fields for filtering:
id
profile.nickname
profile.slug
contact.firstName
contact.lastName
privacyStatus
loginEmail
createdDate
status
userId
Currently supported fields for sorting:
profile.nickname
contact.firstName
contact.lastName
createdDate
lastLoginDate
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Updates a member's properties.
To clear a field's value, set an empty value with an empty string ""
.
To clear the member's addresses, emails, or phone numbers, use these endpoints:
- To clear
contact.addresses
, useDelete Member Addresses
. - To clear
contact.emails
, useDelete Member Emails
. - To clear
contact.phones
, useDelete Member Phones
.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Clears a member's phone numbers.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Clears a member's email addresses.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Deletes a member's street addresses.
deleteMemberAddresses()
clears the addresses
array under the contact
property.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Triggered when a slug is changed.
Event Body
Triggered when a member is deleted.
Event Body
Triggered when a member is created.
The site owner can configure the site to automatically approve members or require manual approval.
A member who has been approved either automatically or manually has a status
of APPROVED
. A created member waiting for approval has a status
of PENDING
. A PENDING
member cannot log into the site.