With the Members API you can provide site members with a personal account area for social communities or non-social businesses. People who sign up to the Members Area get their own account where they can see all their information while getting to know other members. Members can choose if their account is private or public and set up their profile.
With the Members API you can:
There are 6 member types:
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 import site members:
Create a list of members or retrieve the list from the external site. Structure the list as an array of member objects, ensuring that each member has a login email address. For example:
{
"member": {
"loginEmail": "member_needs_an@email.com",
"contact": { ... },
"profile": { ... }
}
}
Iterate through the array, calling Create Member for each member. To comply with rate limits, ensure that requests are sent at least 1 second apart.
Call Send Set Password Email. Your app can trigger the email immediately after creating the member or allow the site owner to send it later. If the email is sent later, your app should iterate through an array of member email addresses, calling Send Set Password Email for each address.
The following table shows field support for filters and sorting for the Member object:
Fields | Supported Filters | Sortable |
---|---|---|
id | $eq , $ne , $in , nin , $exists , $hasSome , $startsWith | Sortable |
loginEmail | $eq , $ne , $in , nin , $exists , $hasSome , $startsWith | Sortable |
contactId | $eq , $ne , $in , nin , $exists , $hasSome , $startsWith | Sortable |
contact.firstName | $eq , $ne , $in , nin , $exists , $hasSome , $startsWith | Sortable |
contact.lastName | $eq , $ne , $in , nin , $exists , $hasSome , $startsWith | Sortable |
profile.nickname | $eq , $ne , $in , nin , $exists , $hasSome , $startsWith | Sortable |
profile.slug | $eq , $ne , $in , nin , $exists , $hasSome , $startsWith | Sortable |
privacyStatus | $eq , $ne , $in , nin , $exists , $hasSome | Sortable |
Member ID.
Email used by the member to log in to the site.
Whether the email used by the member has been verified.
Member site access status.
Contact ID.
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 display details.
Member privacy status.
Member activity status.
Date and time when the member was created.
Date and time when the member was updated.
Date and time when the member last logged in to the site.
Updates the currently logged in member's slug.
Note: This method requires visitor or member authentication.
New slug.
Updated member.
curl -X POST \ https://www.wixapis.com/members/v1/members/my/slug \
-H 'Authorization: <AUTH>'
-d '{
"slug": "john-doe"
}'
{
"member": {
"id": "8a8b9b73-4da8-47a5-8268-4396e68a0605",
"loginEmail": "johndoe@mail.com",
"loginEmailVerified": true,
"status": "APPROVED",
"contactId": "c64c558f-ed41-4395-b820-f8dd66c31702",
"contact": {
"contactId": "c64c558f-ed41-4395-b820-f8dd66c31702",
"firstName": "John",
"lastName": "Doe",
"phones": [],
"emails": [],
"addresses": [],
"customFields": {}
},
"profile": {
"nickname": "John Doe",
"slug": "john-doe",
"photo": {
"id": "",
"url": "https://lh3.googleusercontent.com/a/AEdFTp4_ou_XSV6ZaLtpZDZX55A6fdOpx0X4X8NBeJ_V%3Ds96-c",
"height": 0,
"width": 0
}
},
"privacyStatus": "PUBLIC",
"activityStatus": "ACTIVE",
"createdDate": "2022-12-07T08:27:36Z",
"updatedDate": "2023-03-27T11:43:29.596Z",
"lastLoginDate": "2023-11-08T11:55:30Z"
}
}
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
Updates the member's slug.
Member ID.
New slug.
Updated member.
curl -X POST \
https://www.wixapis.com/members/v1/members/a6a68e95-3821-4b87-9008-b76cdd27f209/slug \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: <AUTH>'
-d '{
"id": "7c86ee9d-9937-4989-98fb-fb5e64131ccc",
"slug": "john-doe"
}'
{
"member": {
"id": "a6a68e95-3821-4b87-9008-b76cdd27f209",
"loginEmail": "john@mail.com",
"status": "OFFLINE",
"contactId": "a6a68e95-3821-4b87-9008-b76cdd27f209",
"contact": {
"contactId": "a6a68e95-3821-4b87-9008-b76cdd27f209",
"phones": [],
"emails": ["john@mail.com"],
"addresses": [],
"customFields": {}
},
"profile": {
"nickname": "john",
"slug": "john-doe"
},
"privacyStatus": "PUBLIC",
"activityStatus": "ACTIVE",
"createdDate": "2021-01-01T14:00:0Z",
"updatedDate": "2024-01-01T15:00:0Z"
}
}
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
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 method requires visitor or member authentication.
The updated member.
curl -X POST \
https://www.wixapis.com/members/v1/members/join-community \
-H 'Authorization: <AUTH>'
{
"member": {
"id": "e62e3011-55cf-4de3-a497-e097b52d86b7",
"loginEmail": "john@example.com",
"status": "APPROVED",
"contactId": "0fac596f-ff7c-4d2b-b826-63c60ee36ee8",
"contact": {
"contactId": "0fac596f-ff7c-4d2b-b826-63c60ee36ee8",
"firstName": "John",
"lastName": "Doe",
"phones": ["2075556300", "2075555217"],
"emails": ["john@example.com"],
"addresses": [],
"customFields": {}
},
"profile": {
"nickname": "John Doe",
"slug": "johndoe",
"photo": {
"id": "a27d24_0dd318~mv2.jpg",
"url": "//static.wixstatic.com/media/a27d24_0dd318~mv2.jpg",
"height": 256,
"width": 256
},
"cover": {
"id": "",
"url": "https://example.com/myimage.jpg",
"height": 1080,
"width": 1920
}
},
"privacyStatus": "PUBLIC",
"activityStatus": "ACTIVE",
"createdDate": "2019-10-30T17:22:10.299Z",
"updatedDate": "2019-11-13T20:14:49.458Z",
"lastLoginDate": "2019-11-13T20:10:49.458Z"
}
}
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
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.
Notes:
The updated member.
curl -X POST \
https://www.wixapis.com/members/v1/members/leave-community \
-H 'Authorization: <AUTH>'
{
"member": {
"id": "e62e3011-55cf-4de3-a497-e097b52d86b7",
"loginEmail": "john@example.com",
"status": "APPROVED",
"contactId": "0fac596f-ff7c-4d2b-b826-63c60ee36ee8",
"contact": {
"contactId": "0fac596f-ff7c-4d2b-b826-63c60ee36ee8",
"firstName": "John",
"lastName": "Doe",
"phones": ["2075556300", "2075555217"],
"emails": ["john@example.com"],
"addresses": [],
"customFields": {}
},
"profile": {
"nickname": "John Doe",
"slug": "johndoe",
"photo": {
"id": "a27d24_0dd318~mv2.jpg",
"url": "//static.wixstatic.com/media/a27d24_0dd318~mv2.jpg",
"height": 256,
"width": 256
},
"cover": {
"id": "",
"url": "https://example.com/myimage.jpg",
"height": 1080,
"width": 1920
}
},
"privacyStatus": "PRIVATE",
"activityStatus": "ACTIVE",
"createdDate": "2019-10-30T17:22:10.299Z",
"updatedDate": "2019-11-13T20:14:49.458Z",
"lastLoginDate": "2019-11-13T20:10:49.458Z"
}
}
Retrieves the currently logged-in member.
Note: This method requires visitor or member authentication.
Predefined set of fields to return.
"FULL"
: Returns all fields."PUBLIC"
: Returns _id
and all fields under profile
.Note:
When returning the "PUBLIC"
fieldset,
profile.status
, profile.privacyStatus
, and profile.activityStatus
are returned as "UNKNOWN"
.
Predefined set of fields to return.
Default: PUBLIC
.
The requested member.
Retrieving my member
curl -X GET \
https://www.wixapis.com/members/v1/members/my \
-H 'Authorization: <AUTH>' \
{
"member": {
"id": "e62e3011-55cf-4de3-a497-e097b52d86b7",
"status": "UNKNOWN",
"profile": {
"nickname": "John Doe",
"slug": "johndoe",
"photo": {
"id": "a27d24_0dd318~mv2.jpg",
"url": "//static.wixstatic.com/media/a27d24_0dd318~mv2.jpg",
"height": 256,
"width": 256
},
"cover": {
"id": "",
"url": "https://example.com/myimage.jpg",
"height": 1080,
"width": 1920
},
"title": "Awesome title"
},
"privacyStatus": "UNKNOWN",
"activityStatus": "UNKNOWN",
"createdDate": "2019-10-30T17:22:10.299Z",
"updatedDate": "2019-11-13T20:14:49.458Z"
}
}
Deletes the currently logged in member.
After calling this method, the member is logged out of the site.
All content created by this member is transferred to another account. For example, if a Wix user had blog posts, those posts are transferred to the specified account, which then becomes the owner of those posts.
Note: This method requires visitor or member authentication.
You can only call this method when authenticated as a Wix app or Wix user identity.
ID of a member receiving deleted member's content.
curl -X DELETE \
https://www.wixapis.com/members/v1/members/my \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: <AUTH>'
-d '{
"contentAssigneeId": "ee616475-4b4a-495e-bf75-896f867dc569"
}
{}
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
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.
Member ID.
Predefined set of fields to return.
Defaults to PUBLIC
.
The requested member.
Retrieving a member by ID
curl -X GET \
https://www.wixapis.com/members/v1/members/e62e3011-55cf-4de3-a497-e097b52d86b7 \
-H 'Authorization: <AUTH>' \
{
"member": {
"id": "e62e3011-55cf-4de3-a497-e097b52d86b7",
"status": "UNKNOWN",
"profile": {
"nickname": "John Doe",
"slug": "johndoe",
"photo": {
"id": "a27d24_0dd318~mv2.jpg",
"url": "//static.wixstatic.com/media/a27d24_0dd318~mv2.jpg",
"height": 256,
"width": 256
},
"cover": {
"id": "",
"url": "https://example.com/myimage.jpg",
"height": 1080,
"width": 1920
},
"title": "Awesome title"
},
"privacyStatus": "UNKNOWN",
"activityStatus": "UNKNOWN",
"createdDate": "2019-10-30T17:22:10.299Z",
"updatedDate": "2019-11-13T20:14:49.458Z"
}
}
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
Deletes a member by ID.
All content created by this member is transferred to a site owner's account. For example, if a Wix user had blog posts, those posts are transferred to the site owner's account, which then becomes the owner of those posts.
You can only call this method when authenticated as a Wix app or Wix user identity.
ID of the member to delete.
curl -X DELETE \
https://www.wixapis.com/members/v1/members/e62e3011-55cf-4de3-a497-e097b52d86b7 \
-H 'Authorization: <AUTH>'
{}
There are 2 errors with this status code:
See the entire list and learn more about Wix errors.
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.Number of items to load.
Number of items to skip in the current sort order.
Predefined sets of fields to return.
Default: PUBLIC
.
Name of the field to sort by.
Sort order.
List of members.
Metadata for the paginated results.
Retrieving members
curl -X GET \
https://www.wixapis.com/members/v1/members \
-H 'Authorization: <AUTH>' \
{
"members": [
{
"id": "e62e3011-55cf-4de3-a497-e097b52d86b7",
"status": "UNKNOWN",
"profile": {
"nickname": "John Doe",
"slug": "johndoe",
"photo": {
"id": "a27d24_0dd318~mv2.jpg",
"url": "//static.wixstatic.com/media/a27d24_0dd318~mv2.jpg",
"height": 256,
"width": 256
},
"cover": {
"id": "",
"url": "https://example.com/myimage.jpg",
"height": 1080,
"width": 1920
},
"title": "Awesome title"
},
"privacyStatus": "UNKNOWN",
"activityStatus": "UNKNOWN",
"createdDate": "2019-10-30T17:22:10.299Z",
"updatedDate": "2019-11-13T20:14:49.458Z"
}
]
}
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.
You can only call this method when authenticated as a Wix app or Wix user identity.
Member to create.
New member.
curl -X POST \
https://www.wixapis.com/members/v1/members \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: <AUTH>'
-d '{
"member": {
"loginEmail": "john@example.com"
}
}'
{
"member": {
"id": "dd7cfd02-1837-4fb8-bc6f-86316f0984a9",
"loginEmail": "john@example.com",
"status": "APPROVED",
"contactId": "124dff0e-a821-47d5-a78c-514d828ccdce",
"contact": {
"contactId": "2aba5ff8-888b-4eab-92d5-53209aa88856",
"phones": [],
"emails": ["john@example.com"],
"addresses": [],
"customFields": {}
},
"profile": {
"nickname": "john",
"slug": "john"
},
"privacyStatus": "PUBLIC",
"activityStatus": "ACTIVE",
"createdDate": "2020-07-17T14:26:32Z",
"updatedDate": "2020-07-17T14:26:31.854Z"
}
}
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
Query options.
Predefined sets of fields to return.
Default: PUBLIC
.
Plain text search.
List of members that met the query filter criteria.
Metadata for the paginated results.
Retrieving members with profile nickname
curl -X POST \
https://www.wixapis.com/members/v1/members/query \
-H 'Authorization: <AUTH>'
-d '{
"query": {
"filter": {
"profile.nickname": "John Doe"
}
}
}'
{
"members": [
{
"id": "e62e3011-55cf-4de3-a497-e097b52d86b7",
"status": "UNKNOWN",
"profile": {
"nickname": "John Doe",
"slug": "johndoe",
"photo": {
"id": "a27d24_0dd318~mv2.jpg",
"url": "//static.wixstatic.com/media/a27d24_0dd318~mv2.jpg",
"height": 256,
"width": 256
},
"cover": {
"id": "",
"url": "",
"height": 0,
"width": 0
},
"title": "Awesome title"
},
"privacyStatus": "UNKNOWN",
"activityStatus": "UNKNOWN",
"createdDate": "2019-10-30T17:22:10.299Z",
"updatedDate": "2019-11-13T20:14:49.458Z"
}
]
}
Mutes a member.
Muted members can't engage with a community. For example, leave comments, like, and share posts or comments.
ID of the member to mute.
Muted member.
curl -X POST \
https://www.wixapis.com/members/v1/members/e62e3011-55cf-4de3-a497-e097b52d86b7/mute \
-H 'Authorization: <AUTH>'
{
"member": {
"id": "e62e3011-55cf-4de3-a497-e097b52d86b7",
"loginEmail": "john@example.com",
"status": "APPROVED",
"contactId": "0fac596f-ff7c-4d2b-b826-63c60ee36ee8",
"contact": {
"contactId": "0fac596f-ff7c-4d2b-b826-63c60ee36ee8",
"firstName": "John",
"lastName": "Doe",
"picture": "https://example.com",
"phones": ["2075556300", "2075555217"],
"emails": ["john@example.com"],
"addresses": [],
"customFields": {}
},
"profile": {
"nickname": "John Doe",
"slug": "johndoe",
"photo": {
"id": "a27d24_0dd318~mv2.jpg",
"url": "//static.wixstatic.com/media/a27d24_0dd318~mv2.jpg",
"height": 256,
"width": 256
},
"cover": {
"id": "",
"url": "https://example.com/myimage.jpg",
"height": 1080,
"width": 1920
}
},
"privacyStatus": "PUBLIC",
"activityStatus": "MUTED",
"createdDate": "2019-10-30T17:22:10.299Z",
"updatedDate": "2019-11-13T20:14:49.458Z",
"lastLoginDate": "2019-11-13T20:10:49.458Z"
}
}
Unmutes a member.
Unmuted members can engage with the comunity. For example, leave comments, like, and share posts.
ID of the member to unmute.
Unmuted member.
curl -X POST \
https://www.wixapis.com/members/v1/members/e62e3011-55cf-4de3-a497-e097b52d86b7/unmute \
-H 'Authorization: <AUTH>'
{
"member": {
"id": "e62e3011-55cf-4de3-a497-e097b52d86b7",
"loginEmail": "john@example.com",
"status": "APPROVED",
"contactId": "0fac596f-ff7c-4d2b-b826-63c60ee36ee8",
"contact": {
"contactId": "0fac596f-ff7c-4d2b-b826-63c60ee36ee8",
"firstName": "John",
"lastName": "Doe",
"picture": "https://example.com",
"phones": ["2075556300", "2075555217"],
"emails": ["john@example.com"],
"addresses": [],
"customFields": {}
},
"profile": {
"nickname": "John Doe",
"slug": "johndoe",
"photo": {
"id": "a27d24_0dd318~mv2.jpg",
"url": "//static.wixstatic.com/media/a27d24_0dd318~mv2.jpg",
"height": 256,
"width": 256
},
"cover": {
"id": "",
"url": "https://example.com/myimage.jpg",
"height": 1080,
"width": 1920
}
},
"privacyStatus": "PUBLIC",
"activityStatus": "ACTIVE",
"createdDate": "2019-10-30T17:22:10.299Z",
"updatedDate": "2019-11-13T20:14:49.458Z",
"lastLoginDate": "2019-11-13T20:10:49.458Z"
}
}
Changes member status to APPROVED
and gives access to members-only pages.
Call this API to:
You can only call this method when authenticated as a Wix app or Wix user identity.
ID of the member to approve.
Approved member.
curl -X POST \
https://www.wixapis.com/members/v1/members/e62e3011-55cf-4de3-a497-e097b52d86b7/approve \
-H 'Authorization: <AUTH>'
{
"member": {
"id": "e62e3011-55cf-4de3-a497-e097b52d86b7",
"loginEmail": "john@example.com",
"status": "APPROVED",
"contactId": "0fac596f-ff7c-4d2b-b826-63c60ee36ee8",
"contact": {
"contactId": "0fac596f-ff7c-4d2b-b826-63c60ee36ee8",
"firstName": "John",
"lastName": "Doe",
"picture": "https://example.com",
"phones": ["2075556300", "2075555217"],
"emails": ["john@example.com"],
"addresses": [],
"customFields": {}
},
"profile": {
"nickname": "John Doe",
"slug": "johndoe",
"photo": {
"id": "a27d24_0dd318~mv2.jpg",
"url": "//static.wixstatic.com/media/a27d24_0dd318~mv2.jpg",
"height": 256,
"width": 256
},
"cover": {
"id": "",
"url": "https://example.com/myimage.jpg",
"height": 1080,
"width": 1920
}
},
"privacyStatus": "PUBLIC",
"activityStatus": "ACTIVE",
"createdDate": "2019-10-30T17:22:10.299Z",
"updatedDate": "2019-11-13T20:14:49.458Z",
"lastLoginDate": "2019-11-13T20:10:49.458Z"
}
}
Blocks a member.
A blocked member can't log in to members-only pages.
To unblock a member, call Approve Member.
You can only call this method when authenticated as a Wix app or Wix user identity.
ID of a member to block.
Blocked member.
curl -X POST \
https://www.wixapis.com/members/v1/members/e62e3011-55cf-4de3-a497-e097b52d86b7/block \
-H 'Authorization: <AUTH>'
{
"member": {
"id": "e62e3011-55cf-4de3-a497-e097b52d86b7",
"loginEmail": "john@example.com",
"status": "BLOCKED",
"contactId": "0fac596f-ff7c-4d2b-b826-63c60ee36ee8",
"contact": {
"contactId": "0fac596f-ff7c-4d2b-b826-63c60ee36ee8",
"firstName": "John",
"lastName": "Doe",
"picture": "https://example.com",
"phones": ["2075556300", "2075555217"],
"emails": ["john@example.com"],
"addresses": [],
"customFields": {}
},
"profile": {
"nickname": "John Doe",
"slug": "johndoe",
"photo": {
"id": "a27d24_0dd318~mv2.jpg",
"url": "//static.wixstatic.com/media/a27d24_0dd318~mv2.jpg",
"height": 256,
"width": 256
},
"cover": {
"id": "",
"url": "https://example.com/myimage.jpg",
"height": 1080,
"width": 1920
}
},
"privacyStatus": "PUBLIC",
"activityStatus": "ACTIVE",
"createdDate": "2019-10-30T17:22:10.299Z",
"updatedDate": "2019-11-13T20:14:49.458Z",
"lastLoginDate": "2019-11-13T20:10:49.458Z"
}
}
There are 2 errors with this status code:
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
Disconnects a member.
A disconnected member can't log in to members-only pages, and the member isn't visible in the dashboard.
Note: This action is irreversible. To connect the same member again, you have to create a member with a new slug.
You can only call this method when authenticated as a Wix app or Wix user identity.
ID of a member to disconnect.
Disconnected member.
curl -X POST \
https://www.wixapis.com/members/v1/members/0ece6e3f-da74-4c77-9f63-9c0ffb5a8161/disconnect \
-H 'Authorization: <AUTH>'
{
"member": {
"id": "0ece6e3f-da74-4c77-9f63-9c0ffb5a8161",
"loginEmail": "john@example.com",
"status": "OFFLINE",
"contactId": "0ece6e3f-da74-4c77-9f63-9c0ffb5a8161",
"contact": {
"contactId": "0ece6e3f-da74-4c77-9f63-9c0ffb5a8161",
"phones": [],
"emails": ["john@example.com"],
"addresses": [],
"customFields": {}
},
"profile": {
"nickname": "john",
"slug": "john"
},
"privacyStatus": "PUBLIC",
"activityStatus": "ACTIVE",
"createdDate": "2021-01-01T14:00:0Z",
"updatedDate": "2024-01-01T15:00:0Z"
}
}
Deletes multiple members by memberId
.
All content created by these members is transferred to a site owner's account. For example, if Wix users had blog posts, those posts are transferred to the site owner's account, which then becomes the owner of those posts.
You can only call this method when authenticated as a Wix app or Wix user identity.
IDs of members to be deleted.
Result.
Bulk action result metadata.
curl -X POST \
https://www.wixapis.com/members/v1/members/bulk/delete \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: <AUTH>'
-d '{
"memberIds": [
"15e3a398-04a6-4acd-8737-e0385cf2e8b8",
]
}
},
{
"results": [
{
"itemMetadata": {
"15e3a398-04a6-4acd-8737-e0385cf2e8b8",
"originalIndex": 0,
"success": true,
"error": {}
}
}
],
"bulkActionMetadata": {
"totalSuccesses": 1,
"totalFailures": 0,
"undetailedFailures": 0
}
}
Deletes multiple members by the specified filter.
All content created by these members is transferred to a site owner's account. For example, if Wix users had blog posts, those posts are transferred to the site owner's account, which then becomes the owner of those posts.
You can only call this method when authenticated as a Wix app or Wix user identity.
Query options. See API Query Language for more details.
ID of a member receiving the deleted member's content.
Plain text search.
Job ID. Pass this ID to Get Async Job to retrieve job details and metadata.
curl -X POST \
https://www.wixapis.com/members/v1/members/bulk/delete-by-filter \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: <AUTH>'
-d '{
"filter": {
"status": {
"$eq": "BLOCKED"
}
},
"contentAssigneeId": "8f6fd6fd-eed1-4e13-8abd-27e8d61ad7be"
},
{
"jobId": "6c79d38a-f262-47df-915b-e544d26e3718"
}
Changes status of multiple members to APPROVED
, and gives access to members-only pages.
Call this API to:
You can only call this method when authenticated as a Wix app or Wix user identity.
Query options. See API Query Language for more details.
Job ID. Pass this ID to Get Async Job to retrieve job details and metadata.
curl -X POST \
https://www.wixapis.com/members/v1/members/bulk/approve-by-filter \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: <AUTH>'
-d '{
"filter": {
"createdDate": {
"$gt": "2025-01-01"
}
}
},
{
"jobId": "53d95257-d323-4cbc-adf3-fb107fcc3a69"
}
Blocks multiple members by a specified filter.
Blocked members can't log in to members-only pages.
To unblock multiple members, call Bulk Approve Members.
You can only call this method when authenticated as a Wix app or Wix user identity.
Query options. See API Query Language for more details.
Job ID. Pass this ID to Get Async Job to retrieve job details and metadata.
curl -X POST \
https://www.wixapis.com/members/v1/members/bulk/block-by-filter \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: <AUTH>'
-d '{
"filter": {
"loginEmailVerified": {
"$eq": false
}
}
},
{
"jobId": "39f2b67f-82d5-4250-a13e-947ed44c8b8d"
}
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
.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.
Privacy status cannot be updated using Update Member. A member can use Leave Community or Join Community to update their privacy status.
Member ID.
Member to update.
Updated member.
curl -X PATCH \
https://www.wixapis.com/members/v1/members/e62e3011-55cf-4de3-a497-e097b52d86b7 \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: <AUTH>'
-d '{
"member": {
"contact": {
"firstName": "John"
}
}
}'
{
"member": {
"id": "e62e3011-55cf-4de3-a497-e097b52d86b7",
"loginEmail": "john@example.com",
"status": "APPROVED",
"contactId": "e62e3011-55cf-4de3-a497-e097b52d86b77",
"contact": {
"contactId": "e62e3011-55cf-4de3-a497-e097b52d86b77",
"firstName": "John",
"lastName": "Doe",
"phones": ["2075556300"],
"emails": ["john@example.com"],
"addresses": [],
"customFields": {}
},
"profile": {
"nickname": "John Doe",
"slug": "john-doe",
"photo": {
"id": "a27d24_0dd318%7Emv2.jpg",
"url": "//static.wixstatic.com/media/a27d24_0dd318%7Emv2.jpg",
"height": 0,
"width": 0
},
"cover": {
"id": "",
"url": "https://example.com/myimage.jpg",
"height": 0,
"width": 0
},
"title": "Awesome title"
},
"privacyStatus": "PUBLIC",
"activityStatus": "ACTIVE",
"createdDate": "2020-07-27T15:19:26Z",
"updatedDate": "2020-07-27T15:25:27.185Z",
"lastLoginDate": "2020-07-27T15:20:27.185Z"
}
}
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
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.
ID of the member whose phone numbers will be deleted.
Updated member.
curl -X DELETE \
https://www.wixapis.com/members/v1/members/e62e3011-55cf-4de3-a497-e097b52d86b7/phones \
-H 'Authorization: <AUTH>'
{
"member": {
"id": "e62e3011-55cf-4de3-a497-e097b52d86b7",
"loginEmail": "john@example.com",
"status": "APPROVED",
"contactId": "0fac596f-ff7c-4d2b-b826-63c60ee36ee8",
"contact": {
"contactId": "0fac596f-ff7c-4d2b-b826-63c60ee36ee8",
"firstName": "John",
"lastName": "Doe",
"phones": [],
"emails": ["john@example.com"],
"addresses": [
{
"id": "399d8767-bee2-44fc-bbe4-b9aa8325ff31",
"addressLine": "76 Cedarstone Drive",
"city": "Jewell",
"subdivision": "Ohio",
"country": "United States",
"postalCode": "43530"
}
],
"customFields": {}
},
"profile": {
"nickname": "John Doe",
"slug": "johndoe",
"photo": {
"id": "a27d24_0dd318~mv2.jpg",
"url": "//static.wixstatic.com/media/a27d24_0dd318~mv2.jpg",
"height": 256,
"width": 256
},
"cover": {
"id": "",
"url": "https://example.com/myimage.jpg",
"height": 1080,
"width": 1920
}
},
"privacyStatus": "PUBLIC",
"activityStatus": "ACTIVE",
"createdDate": "2019-10-30T17:22:10.299Z",
"updatedDate": "2019-11-13T20:14:49.458Z",
"lastLoginDate": "2019-11-13T20:10:49.458Z"
}
}
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.
ID of the member whose email addresses will be deleted.
Updated member.
curl -X DELETE \
https://www.wixapis.com/members/v1/members/e62e3011-55cf-4de3-a497-e097b52d86b7/emails \
-H 'Authorization: <AUTH>'
{
"member": {
"id": "e62e3011-55cf-4de3-a497-e097b52d86b7",
"loginEmail": "john@example.com",
"status": "APPROVED",
"contactId": "0fac596f-ff7c-4d2b-b826-63c60ee36ee8",
"contact": {
"contactId": "0fac596f-ff7c-4d2b-b826-63c60ee36ee8",
"firstName": "John",
"lastName": "Doe",
"phones": ["2075556300", "2075555217"],
"emails": [],
"addresses": [
{
"id": "399d8767-bee2-44fc-bbe4-b9aa8325ff31",
"addressLine": "76 Cedarstone Drive",
"city": "Jewell",
"subdivision": "Ohio",
"country": "United States",
"postalCode": "43530"
}
],
"customFields": {}
},
"profile": {
"nickname": "John Doe",
"slug": "johndoe",
"photo": {
"id": "a27d24_0dd318~mv2.jpg",
"url": "//static.wixstatic.com/media/a27d24_0dd318~mv2.jpg",
"height": 256,
"width": 256
},
"cover": {
"id": "",
"url": "https://example.com/myimage.jpg",
"height": 1080,
"width": 1920
}
},
"privacyStatus": "PUBLIC",
"activityStatus": "ACTIVE",
"createdDate": "2019-10-30T17:22:10.299Z",
"updatedDate": "2019-11-13T20:14:49.458Z",
"lastLoginDate": "2019-11-13T20:10:49.458Z"
}
}
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.
ID of the member whose street addresses will be deleted.
Updated member.
curl -X DELETE \
https://www.wixapis.com/members/v1/members/e62e3011-55cf-4de3-a497-e097b52d86b7/addresses \
-H 'Authorization: <AUTH>'
{
"member": {
"id": "e62e3011-55cf-4de3-a497-e097b52d86b7",
"loginEmail": "john@example.com",
"status": "APPROVED",
"contact": {
"contactId": "0fac596f-ff7c-4d2b-b826-63c60ee36ee8",
"firstName": "John",
"lastName": "Doe",
"phones": ["2075556300", "2075555217"],
"emails": ["john@example.com"],
"addresses": [],
"customFields": {}
},
"profile": {
"nickname": "John Doe",
"slug": "johndoe",
"photo": {
"id": "a27d24_0dd318~mv2.jpg",
"url": "//static.wixstatic.com/media/a27d24_0dd318~mv2.jpg",
"height": 256,
"width": 256
},
"cover": {
"id": "",
"url": "https://example.com/myimage.jpg",
"height": 1080,
"width": 1920
}
},
"privacyStatus": "PUBLIC",
"activityStatus": "ACTIVE",
"createdDate": "2019-10-30T17:22:10.299Z",
"updatedDate": "2019-11-13T20:14:49.458Z",
"lastLoginDate": "2019-11-13T20:10:49.458Z"
}
}
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.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.members.v1.member
.
Event name. Expected created
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.members.v1.member_created",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "87c0d894-4ed1-4c75-b167-27b7622558d2",
"entityFqdn": "wix.members.v1.member",
"slug": "created",
"entityId": "89f3da66-abcb-4b0f-bb1d-68ce0faaaa12",
"createdEvent": {
"entity": {
"loginEmail": "john@example.com",
"privacyStatus": "PUBLIC",
"contactId": "89f3da66-abcb-4b0f-bb1d-68ce0faaaa12",
"contact": {
"contactId": "89f3da66-abcb-4b0f-bb1d-68ce0faaaa12",
"emails": ["john@example.com"]
},
"id": "89f3da66-abcb-4b0f-bb1d-68ce0faaaa12",
"activityStatus": "ACTIVE",
"profile": {
"nickname": "John Doe",
"slug": "johndoe"
},
"status": "APPROVED",
"updatedDate": "2021-01-27T11:23:42.486Z",
"createdDate": "2021-01-27T11:23:42Z",
"lastLoginDate": "2021-01-27T11:23:43Z"
}
},
"eventTime": "2021-01-27T11:23:43.804694Z",
"triggeredByAnonymizeRequest": false
}
Triggered when a member is deleted.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.members.v1.member
.
Event name. Expected deleted
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.members.v1.member_deleted",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "5c04db07-eeeb-4664-ba79-a13ff83306b8",
"entityFqdn": "wix.members.v1.member",
"slug": "deleted",
"entityId": "a1b04c2c-f60b-4d18-b347-941b500388a7",
"actionEvent": {
"body": {}
},
"eventTime": "2021-01-27T11:23:43.804694Z",
"triggeredByAnonymizeRequest": false
}
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.members.v1.member
.
Event name. Expected updated
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.members.v1.member_updated",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "6019f148-067e-49e8-b5de-797da97a7b9a",
"entityFqdn": "wix.members.v1.member",
"slug": "updated",
"entityId": "89f3da66-abcb-4b0f-bb1d-68ce0faaaa12",
"updatedEvent": {
"currentEntity": {
"loginEmail": "john@example.com",
"privacyStatus": "PUBLIC",
"contactId": "89f3da66-abcb-4b0f-bb1d-68ce0faaaa12",
"contact": {
"contactId": "89f3da66-abcb-4b0f-bb1d-68ce0faaaa12",
"emails": ["john@example.com"],
"addresses": [
{
"country": "IE"
}
]
},
"id": "89f3da66-abcb-4b0f-bb1d-68ce0faaaa12",
"activityStatus": "ACTIVE",
"profile": {
"nickname": "John Doe",
"slug": "johndoe"
},
"status": "APPROVED",
"updatedDate": "2021-01-27T11:23:42.486Z",
"createdDate": "2021-01-27T11:23:42Z",
"lastLoginDate": "2021-01-27T11:23:43Z"
}
},
"eventTime": "2021-01-27T11:23:43.804694Z",
"triggeredByAnonymizeRequest": false
}