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.
UNKNOWN
, PENDING
, APPROVED
, BLOCKED
, OFFLINE
,
UNKNOWN
, PRIVATE
, PUBLIC
,
UNKNOWN
, ACTIVE
, MUTED
,
Retrieves a member by ID.
PUBLIC
fieldset returns id
, contactId
, and the profile
object. status
, privacyStatus
and activityStatus
are returned as UNKNOWN
.EXTENDED
fieldset returns id
, loginEmail
, status
, contactId
, privacyStatus
, activityStatus
, and the profile
object.FULL
fieldset returns all fields.Deletes a member.
Lists site members, given the provided paging and fieldsets.
PUBLIC
fieldset returns id
and profile
object. status
, privacyStatus
and activityStatus
are returned as UNKNOWN
.FULL
fieldset returns all fields.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.
Retrieves a list of up to 100 members, given the provided filters, fieldsets, sorting and paging.
PUBLIC
fieldset returns id
and profile
object. status
, privacyStatus
and activityStatus
are returned as UNKNOWN
.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
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:
contact.addresses
, use Delete Member Addresses
.contact.emails
, use Delete Member Emails
.contact.phones
, use Delete Member Phones
.Clears a member's phone numbers.
Clears a member's email addresses.
Deletes a member's street addresses.
deleteMemberAddresses()
clears the addresses
array under the contact
property.
Triggered when a slug is changed.
Triggered when a member is deleted.
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.