Introduction

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.

About Wix Members

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 Scope

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)

Members Types

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

Use Cases

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)
Was this helpful?
Yes
No

About Wix Members

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.

Member Types

General Status

Blocked - this member can not log-in to the site.

Pending - this member has requested to join the site and is waitng for approval.

Privacy Status

Private - this member's data is available only to themselves and the site owner.

Public - this member's data is available to all.

Activity Status

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.).

Query argument

FieldSet

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.

Was this helpful?
Yes
No

Example Flows

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.

Importing Site Members

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:

  1. 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
    1
    {
    2
    "member": {
    3
    "loginEmail": "member_needs_an@email.com",
    4
    "contact": { ... },
    5
    "profile": { ... }
    6
    }
    7
    }
  2. Iterate over the array, calling Create Member for each member. To keep below rate limits, set your requests at least 1 second apart.

  3. 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.

Was this helpful?
Yes
No

Member Object

Attributes
idstringRead-onlyformat GUID
Member ID.

loginEmailstringformat EMAIL
Email used by the member to log in to the site.

loginEmailVerifiedbooleanRead-only
Whether the email used by the member has been verified.

statusstringRead-only
5 supported values:
UNKNOWNPENDINGAPPROVEDBLOCKEDOFFLINE
Member site access status.
  • 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.

contactIdstringRead-onlyformat GUID
Contact ID.

contactobject
Member's contact information. Contact information is stored in the Contact List. The full set of contact data can be accessed and managed with the Contacts API.

profileobject
Profile display info.

privacyStatusstring
3 supported values:
UNKNOWNPRIVATEPUBLIC
Member privacy 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.

activityStatusstringRead-only
3 supported values:
UNKNOWNACTIVEMUTED
Member activity 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.

createdDatestringRead-onlyformat date-time
Date and time when the member was created.

updatedDatestringRead-onlyformat date-time
Date and time when the member was updated.

lastLoginDatestringRead-onlyformat date-time
Date and time when the member last logged in to the site.
Was this helpful?
Yes
No

PostUpdate My Slug

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates the currently logged in member's slug.

Note: This endpoint is relevant only for Headless projects.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Members
Manage Bookings Services and Settings
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/members/v1/members/my/slug

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostJoin Community

Joins the currently logged-in member to the site community and sets their profile to public.

When a member's profile is public, they have access to the site's Members Area features — such as chat, forum, and followers — and their profile is visible to other members and site visitors.

Note: This endpoint is relevant only for Headless projects.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings Services and Settings
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/members/v1/members/join-community

Was this helpful?
Yes
No

PostLeave Community

Removes the currently logged-in member from the site community and sets their profile to private.

When a member's profile is private, they do not have access to the site's Members Area features — such as chat, forum, and followers — and their profile is hidden from other members and site visitors.

Note: If a member leaves the site's community, their content (such as forum posts and blog comments) remain publicly visible.

Note: This endpoint is relevant only for Headless projects.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings Services and Settings
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/members/v1/members/leave-community

Was this helpful?
Yes
No

GetGet My Member

Retrieves the currently logged-in member.

Note: This endpoint is relevant only for Headless projects.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Members
Manage Bookings Services and Settings
Read Members and Contacts - all read permissions
Read Members
Manage Members and Contacts - all permissions
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/members/v1/members/my

Was this helpful?
Yes
No

GetGet Member

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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.

Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Members
Manage Bookings Services and Settings
Read Members and Contacts - all read permissions
Read Members
Manage Members and Contacts - all permissions
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/members/v1/members/{id}

Was this helpful?
Yes
No

DeleteDelete Member

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Deletes a member by ID.

Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Members
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
DELETE
https://www.wixapis.com/members/v1/members/{id}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

GetList Members

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Members
Manage Bookings Services and Settings
Read Members and Contacts - all read permissions
Read Members
Manage Members and Contacts - all permissions
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/members/v1/members

Was this helpful?
Yes
No

PostCreate Member

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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:
Manage Members
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/members/v1/members

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostQuery Members

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Members
Manage Bookings Services and Settings
Read Members and Contacts - all read permissions
Read Members
Manage Members and Contacts - all permissions
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/members/v1/members/query

Was this helpful?
Yes
No

PatchUpdate Member

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:

Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Members
Manage Bookings Services and Settings
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
PATCH
https://www.wixapis.com/members/v1/members/{member.id}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

DeleteDelete Member Phones

Clears a member's phone numbers.

Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Members
Manage Bookings Services and Settings
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
DELETE
https://www.wixapis.com/members/v1/members/{id}/phones

Was this helpful?
Yes
No

DeleteDelete Member Emails

Clears a member's email addresses.

Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Members
Manage Bookings Services and Settings
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
DELETE
https://www.wixapis.com/members/v1/members/{id}/emails

Was this helpful?
Yes
No

DeleteDelete Member Addresses

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Deletes a member's street addresses.

Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Members
Manage Bookings Services and Settings
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
DELETE
https://www.wixapis.com/members/v1/members/{id}/addresses

Was this helpful?
Yes
No

Member Updated

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

NOTE to TWs: - below callback is not included in docs. Do NOT edit here. Edit callback listed under UpdateMemberSlug.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Members
Manage Bookings Services and Settings
Read Members and Contacts - all read permissions
Read Members
Manage Members and Contacts - all permissions
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.members.v1.member.

slugstring
Event name. Expected updated.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

updatedEventobject
Event information.
Was this helpful?
Yes
No

Member Deleted

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a member is deleted.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Members
Manage Bookings Services and Settings
Read Members and Contacts - all read permissions
Read Members
Manage Members and Contacts - all permissions
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.members.v1.member.

slugstring
Event name. Expected deleted.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

deletedEventstruct
Event information.
Was this helpful?
Yes
No

Member Created

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Members
Manage Bookings Services and Settings
Read Members and Contacts - all read permissions
Read Members
Manage Members and Contacts - all permissions
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.members.v1.member.

slugstring
Event name. Expected created.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

createdEventobject
Event information.
Was this helpful?
Yes
No