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 Code
    {
    "member": {
    "loginEmail": "member_needs_an@email.com",
    "contact": { ... },
    "profile": { ... }
    }
    }
  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

id
string
READ ONLY
format GUID
.
Member ID.

loginEmail
string
format EMAIL
.
Email used by the member to log in to the site.

loginEmailVerified
boolean
READ ONLY
Whether the email used by the member has been verified.

status
string
READ ONLY
5 supported values:

UNKNOWN, PENDING, APPROVED, BLOCKED, OFFLINE,

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.

contactId
string
READ ONLY
format GUID
.
Contact ID.

contact
object
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.

profile
object
Profile display info.

privacyStatus
string
3 supported values:

UNKNOWN, PRIVATE, PUBLIC,

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.

activityStatus
string
READ ONLY
3 supported values:

UNKNOWN, ACTIVE, MUTED,

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.

createdDate
string
READ ONLY
format date-time
.
Date and time when the member was created.

updatedDate
string
READ ONLY
format date-time
.
Date and time when the member was updated.

lastLoginDate
string
READ ONLY
format date-time
.
Date and time when the member last logged in to the site.
Was this helpful?
Yes
No

get

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Members
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

GET
https://www.wixapis.com/members/v1/members/{id}

Was this helpful?
Yes
No

delete

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

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

Syntax

DELETE
https://www.wixapis.com/members/v1/members/{id}

Event Triggers

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

get

List 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:
Read Members
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

GET
https://www.wixapis.com/members/v1/members

Was this helpful?
Yes
No

post

Create 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

Syntax

POST
https://www.wixapis.com/members/v1/members

Event Triggers

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

post

Query 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:
Read Members
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/members/v1/members/query

Was this helpful?
Yes
No

patch

Update 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:

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

Syntax

PATCH
https://www.wixapis.com/members/v1/members/{member.id}

Event Triggers

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

delete

Delete Member Phones

Clears a member's phone numbers.

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

Syntax

DELETE
https://www.wixapis.com/members/v1/members/{id}/phones

Was this helpful?
Yes
No

delete

Delete Member Emails

Clears a member's email addresses.

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

Syntax

DELETE
https://www.wixapis.com/members/v1/members/{id}/emails

Was this helpful?
Yes
No

delete

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

deleteMemberAddresses() clears the addresses array under the contact property.

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

Syntax

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.

Triggered when a slug is changed.

Permissions

MEMBERS.MEMBER_READ
Learn more about permissions.

Event Body

Event 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

id
string
Unique event ID. Allows clients to ignore duplicate webhooks.

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

slug
string
Event name. Expected
updated
.

entityId
string
ID of the entity associated with the event.

eventTime
string
format date-time
.
Event timestamp.

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

originatedFrom
string
If present, indicates the action that triggered the event.

updatedEvent
object
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.

Permissions

MEMBERS.MEMBER_READ
Learn more about permissions.

Event Body

Event 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

id
string
Unique event ID. Allows clients to ignore duplicate webhooks.

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

slug
string
Event name. Expected
deleted
.

entityId
string
ID of the entity associated with the event.

eventTime
string
format date-time
.
Event timestamp.

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

originatedFrom
string
If present, indicates the action that triggered the event.

deletedEvent
struct
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.

Permissions

MEMBERS.MEMBER_READ
Learn more about permissions.

Event Body

Event 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

id
string
Unique event ID. Allows clients to ignore duplicate webhooks.

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

slug
string
Event name. Expected
created
.

entityId
string
ID of the entity associated with the event.

eventTime
string
format date-time
.
Event timestamp.

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

originatedFrom
string
If present, indicates the action that triggered the event.

createdEvent
object
Event information.
Was this helpful?
Yes
No