With the Members About V2 API, you can create and manage content for the "About" section in the member's profile. This section is initially blank, so members can write whatever they want to share. The section also supports rich content in this description, such as images, videos and GIFs, making it easy to create visually engaging descriptions.
The Members About API V2 allows you to:
It’s important to note the following points before starting to code:
The following table shows field support for filters and sorting for the Member About object:
Fields | Supported Filters | Sortable |
---|---|---|
id | $eq , $ne , $in , nin , $exists , $hasSome , $startsWith | Sortable |
memberId | $eq , $ne , $in , nin , $exists , $hasSome , $startsWith | Sortable |
This article presents possible use cases and corresponding sample flows that you can support. This can be a helpful jumping-off point as you plan your implementation.
To maintain a safe and respectful online community, platforms often need to moderate the content members write in their "About" sections. This ensures compliance with community guidelines, legal standards, or platform-specific rules (for example, no offensive language, hate speech, or personal contact details). For example, a member filled in the "About" section using curse words. Your app could detect and flag such inappropriate or prohibited content and notify the site owner.
To moderate content of the "About" sections:
Call Query Member Abouts to retrieve the content of all site members.
Integrate the retrieved content with an AI-powered content moderation service (for example, AWS Comprehend, Google Cloud Content Safety API, or OpenAI).
Scan for:
If inappropriate content is detected:
Call Update Member About to temporarily replace the content with a placeholder message (for example, "This section is under review for potential violations of our guidelines").
Provide flagged content to human moderators for review. Moderators could:
ID of the "About" section content.
Revision number, which increments by 1 each time the "About" section content is updated. To prevent conflicting changes, the existing revision must be used when updating an "About" section content.
Member ID.
This field uses Ricos Document, a structured rich content data format. For a quick start, copy the JSON content from the sample playground below. Learn more about Rich Content (SDK | REST).
image
video
divider
giphy
emoji
link
{
"memberAbout": {
"id": "e901b292-70f0-4a20-8aaf-e06cd5dc5ca2",
"revision": "1",
"memberId": "9e4f34b3-ebb8-49ee-a342-057d7e70cf5a",
"content": {
"nodes": [
{
"type": "HEADING",
"id": "foo",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "About Me"
}
}
],
"headingData": {
"level": 2,
"textStyle": {
"textAlignment": "AUTO"
}
}
},
{
"type": "PARAGRAPH",
"id": "lxr936"
},
{
"type": "PARAGRAPH",
"id": "j7tdj13",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Hi, I'm Sarah! I'm a graphic designer and nature enthusiast. I love hiking, photography, and discovering new coffee shops. Always happy to connect with like-minded people!"
}
}
]
}
]
}
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates the "About" section content for a member.
The "About" section content to create.
The created "About" section content.
curl -X POST \
https://www.wixapis.com/members/v2/abouts \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: <AUTH>'
-d '{
"memberAbout": {
"memberId": "9e4f34b3-ebb8-49ee-a342-057d7e70cf5a",
"content": {
"nodes": [
{
"type": "HEADING",
"id": "foo",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "About Me"
}
}
],
"headingData": {
"level": 2,
"textStyle": {
"textAlignment": "AUTO"
}
}
},
{
"type": "PARAGRAPH",
"id": "lxr936"
},
{
"type": "PARAGRAPH",
"id": "j7tdj13",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Hi, I'm Sarah! I'm a graphic designer and nature enthusiast. I love hiking, photography, and discovering new coffee shops. Always happy to connect with like-minded people!"
}
}
]
}
]
}
}
}'
{
"memberAbout": {
"id": "e901b292-70f0-4a20-8aaf-e06cd5dc5ca2",
"revision": "1",
"memberId": "9e4f34b3-ebb8-49ee-a342-057d7e70cf5a",
"content": {
"nodes": [
{
"type": "HEADING",
"id": "foo",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "About Me"
}
}
],
"headingData": {
"level": 2,
"textStyle": {
"textAlignment": "AUTO"
}
}
},
{
"type": "PARAGRAPH",
"id": "lxr936"
},
{
"type": "PARAGRAPH",
"id": "j7tdj13",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Hi, I'm Sarah! I'm a graphic designer and nature enthusiast. I love hiking, photography, and discovering new coffee shops. Always happy to connect with like-minded people!"
}
}
]
}
]
}
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Updates the "About" section content.
Each time the "About" section content is updated, revision increments by 1. The existing revision must be included when updating the "About" section content. This ensures you're working with the latest "About" section and prevents unintended overwrites.
ID of the "About" section content.
The "About" section content to update.
The updated "About" section content.
curl -X PATCH \
https://www.wixapis.com/members/v2/abouts/e901b292-70f0-4a20-8aaf-e06cd5dc5ca2 \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: <AUTH>'
-d '{
"memberAbout": {
"memberId": "9e4f34b3-ebb8-49ee-a342-057d7e70cf5a",
"content": {
"nodes": [
{
"type": "HEADING",
"id": "foo",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "About Me"
}
}
],
"headingData": {
"level": 2,
"textStyle": {
"textAlignment": "AUTO"
}
}
},
{
"type": "PARAGRAPH",
"id": "lxr936"
},
{
"type": "PARAGRAPH",
"id": "j7tdj13",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Hi, I'm Sarah! I'm a graphic designer and nature enthusiast. I love hiking, photography, and discovering new coffee shops. Always happy to connect with like-minded people!"
}
}
]
}
]
},
"revision": "2"
}
}'
{
"memberAbout": {
"id": "e901b292-70f0-4a20-8aaf-e06cd5dc5ca2",
"revision": "3",
"memberId": "9e4f34b3-ebb8-49ee-a342-057d7e70cf5a",
"content": {
"nodes": [
{
"type": "HEADING",
"id": "foo",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "About Me"
}
}
],
"headingData": {
"level": 2,
"textStyle": {
"textAlignment": "AUTO"
}
}
},
{
"type": "PARAGRAPH",
"id": "lxr936"
},
{
"type": "PARAGRAPH",
"id": "j7tdj13",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Hi, I'm Sarah! I'm a graphic designer and nature enthusiast. I love hiking, photography, and discovering new coffee shops. Always happy to connect with like-minded people!"
}
}
]
}
]
}
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves the "About" section content.
ID of the "About" section content to retrieve.
The retrieved "About" section content.
curl -X GET \
https://www.wixapis.com/members/v2/abouts/e901b292-70f0-4a20-8aaf-e06cd5dc5ca2 \
-H 'Authorization: <AUTH>'
{
"memberAbout": {
"id": "e901b292-70f0-4a20-8aaf-e06cd5dc5ca2",
"revision": "1",
"memberId": "9e4f34b3-ebb8-49ee-a342-057d7e70cf5a",
"content": {
"nodes": [
{
"type": "HEADING",
"id": "foo",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "About Me"
}
}
],
"headingData": {
"level": 2,
"textStyle": {
"textAlignment": "AUTO"
}
}
},
{
"type": "PARAGRAPH",
"id": "lxr936"
},
{
"type": "PARAGRAPH",
"id": "j7tdj13",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Hi, I'm Sarah! I'm a graphic designer and nature enthusiast. I love hiking, photography, and discovering new coffee shops. Always happy to connect with like-minded people!"
}
}
]
}
]
}
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deletes the "About" section content.
ID of the "About" section content to delete.
curl -X DELETE \
https://www.wixapis.com/members/v2/abouts/e901b292-70f0-4a20-8aaf-e06cd5dc5ca2 \
-H 'Authorization: <AUTH>'
{}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves the "About" section content of a currently logged in member.
Note: This method requires visitor or member authentication.
The "About" section content of a currently logged in member.
curl -X GET \
https://www.wixapis.com/members/v2/abouts/my \
-H 'Authorization: <AUTH>'
{
"memberAbout": {
"id": "e901b292-70f0-4a20-8aaf-e06cd5dc5ca2",
"revision": "1",
"memberId": "9e4f34b3-ebb8-49ee-a342-057d7e70cf5a",
"content": {
"nodes": [
{
"type": "HEADING",
"id": "foo",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "About Me"
}
}
],
"headingData": {
"level": 2,
"textStyle": {
"textAlignment": "AUTO"
}
}
},
{
"type": "PARAGRAPH",
"id": "lxr936"
},
{
"type": "PARAGRAPH",
"id": "j7tdj13",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Hi, I'm Sarah! I'm a graphic designer and nature enthusiast. I love hiking, photography, and discovering new coffee shops. Always happy to connect with like-minded people!"
}
}
]
}
]
}
}
}
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 content from the "About" sections, given the provided paging, filtering, and sorting. Query Member Abouts runs with these defaults, which you can override:
createdDate
is sorted in ASC
orderpaging.limit
is 100
paging.offset
is 0
For field support for filters and sorting, see Member About: Supported Filters and Sorting. To learn about working with Query endpoints, see API Query Language
Query options. See API Query Language for more details.
The retrieved content from the "About" sections.
Metadata for the paginated results.
curl -X POST \
https://www.wixapis.com/members/v2/abouts/query \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: <AUTH>'
-d '{
"query": {
"filter": {
"memberId": "9e4f34b3-ebb8-49ee-a342-057d7e70cf5d"
}
}
}'
{
"memberAbouts": [
{
"id": "e18779d5-956d-49c7-93da-8fa9f64704ce",
"revision": "1",
"memberId": "9e4f34b3-ebb8-49ee-a342-057d7e70cf5d",
"content": {
"nodes": [
{
"type": "HEADING",
"id": "foo",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "About Me"
}
}
],
"headingData": {
"level": 2,
"textStyle": {
"textAlignment": "AUTO"
}
}
},
{
"type": "PARAGRAPH",
"id": "lxr936"
},
{
"type": "PARAGRAPH",
"id": "j7tdj13",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Hi, I'm Sarah! I'm a graphic designer and nature enthusiast. I love hiking, photography, and discovering new coffee shops. Always happy to connect with like-minded people!"
}
}
]
}
]
}
}
],
"metadata": {
"count": 1,
"cursors": {
"next": null,
"prev": null
},
"hasNext": false,
"total": null
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when the "About" section content is created.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.members.about.v2.member_about
.
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.about.v2.member_about_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": "9aca3895-8c58-48b7-84a5-35bcd431c125",
"entityFqdn": "wix.members.about.v2.member_about",
"slug": "created",
"entityId": "e901b292-70f0-4a20-8aaf-e06cd5dc5ca2",
"eventTime": "2024-01-01T01:01:01.01Z",
"createdEvent": {
"entity": {
"memberAbout": {
"id": "e901b292-70f0-4a20-8aaf-e06cd5dc5ca2",
"revision": "1",
"memberId": "9e4f34b3-ebb8-49ee-a342-057d7e70cf5a",
"content": {
"nodes": [
{
"type": "HEADING",
"id": "foo",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "About Me"
}
}
],
"headingData": {
"level": 2,
"textStyle": {
"textAlignment": "AUTO"
}
}
},
{
"type": "PARAGRAPH",
"id": "lxr936"
},
{
"type": "PARAGRAPH",
"id": "j7tdj13",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Hi, I'm Sarah! I'm a graphic designer and nature enthusiast. I love hiking, photography, and discovering new coffee shops. Always happy to connect with like-minded people!"
}
}
]
}
]
}
}
}
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when the "About" section content 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.about.v2.member_about
.
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.about.v2.member_about_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": "9aca3895-8c58-48b7-84a5-35bcd431c125",
"entityFqdn": "wix.members.about.v2.member_about",
"slug": "deleted",
"entityId": "e901b292-70f0-4a20-8aaf-e06cd5dc5ca2",
"deletedEvent": {},
"eventTime": "2024-01-01T01:01:01.01Z",
"triggeredByAnonymizeRequest": true
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when the "About" section content is updated.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.members.about.v2.member_about
.
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.about.v2.member_about_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": "9aca3895-8c58-48b7-84a5-35bcd431c125",
"entityFqdn": "wix.members.about.v2.member_about",
"slug": "updated",
"entityId": "e901b292-70f0-4a20-8aaf-e06cd5dc5ca2",
"eventTime": "2024-03-04T01:01:01.01Z",
"updatedEvent": {
"currentEntity": {
"memberAbout": {
"id": "e901b292-70f0-4a20-8aaf-e06cd5dc5ca2",
"revision": "1",
"memberId": "9e4f34b3-ebb8-49ee-a342-057d7e70cf5a",
"content": {
"nodes": [
{
"type": "HEADING",
"id": "foo",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "About Me"
}
}
],
"headingData": {
"level": 2,
"textStyle": {
"textAlignment": "AUTO"
}
}
},
{
"type": "PARAGRAPH",
"id": "lxr936"
},
{
"type": "PARAGRAPH",
"id": "j7tdj13",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Hi, I'm Sarah! I'm a graphic designer and nature enthusiast. I love hiking, photography, and discovering new coffee shops. Always happy to connect with like-minded people!"
}
}
]
}
]
}
}
}
}
}