Introduction

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:

Before you begin

It’s important to note the following points before starting to code:

Use cases

Terminology

  • Member Profile: A personalized space within the Members Area where a member's details and activity are displayed. The profile typically includes basic information (for example, name, profile picture), contact details, and additional sections such as "about," where members can share more about themselves.
  • About: A customizable section in the member's profile where they can share personal or professional information. This section can include plain text, rich content like images, videos, and GIFs, or a combination of these elements to help express the member’s personality, interests, or background.
  • Rich Content: Digital content that includes elements beyond plain text, such as images, videos, and interactive components.
Did this help?

Member About: Supported Filters and Sorting

The following table shows field support for filters and sorting for the Member About object:

FieldsSupported FiltersSortable
id$eq, $ne, $in, nin, $exists, $hasSome, $startsWithSortable
memberId$eq, $ne, $in, nin, $exists, $hasSome, $startsWithSortable
Did this help?

Member About: Sample Use Cases and Flows

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.

Moderate Content for About Sections

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:

  1. Call Query Member Abouts to retrieve the content of all site members.

  2. Integrate the retrieved content with an AI-powered content moderation service (for example, AWS Comprehend, Google Cloud Content Safety API, or OpenAI).

    Scan for:

    • Prohibited language: Offensive, discriminatory, or violent speech. For example, the moderation flag could be "Contains offensive language."
    • Malicious content: Links to harmful websites or phishing attempts. For example, the moderation flag could be "Includes an external URL."
  3. If inappropriate content is detected:

    • Flag the member's "About" section for review.
    • Notify the member with a reason for the flagging and a link to the community guidelines.
  4. 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").

  5. Provide flagged content to human moderators for review. Moderators could:

Did this help?

Member About Object


Properties
idstringRead-onlyformat GUID

ID of the "About" section content.


revisionintegerformat uint64

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.


memberIdstringformat GUID

Member ID.


contentContent

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

{
"nodes": [
{
"id": "mbirg177",
"type": "BLOCKQUOTE",
"nodes": [
{
"id": "u4p73323",
"type": "PARAGRAPH",
"nodes": [
{
"id": "",
"type": "TEXT",
"textData": {
"text": "my custom docs example"
}
}
]
}
],
"blockquoteData": {
"indentation": 0
}
},
{
"id": "wlg55325",
"type": "PARAGRAPH"
}
]
}
Note: This API enables the following Ricos plugins :
imagevideodividergiphyemojilink

MemberAbout
JSON
{ "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!" } } ] } ] } } }
Did this help?

POST

Create Member About


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 the "About" section content for a member.

Permissions
SCOPE.DC-MEMBERS.MANAGE-ABOUT
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/members/v2/abouts

Body Params
memberAboutMemberAboutRequired

The "About" section content to create.

Response Object
memberAboutMemberAbout

The created "About" section content.

Create the Member "About" Section Content
Request
cURL
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!" } } ] } ] } } }'
Response
JSON
{ "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!" } } ] } ] } } }
Event TriggersThis method triggers the following events:
Did this help?

PATCH

Update Member About


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

Permissions
SCOPE.DC-MEMBERS.MANAGE-ABOUT
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/members/v2/abouts/{memberAbout.id}

Path Params
memberAbout.idstringRequired

ID of the "About" section content.

Body Params
memberAboutMemberAboutRequired

The "About" section content to update.

Response Object
memberAboutMemberAbout

The updated "About" section content.

Update Member "About" Section Content
Request
cURL
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" } }'
Response
JSON
{ "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!" } } ] } ] } } }
Event TriggersThis method triggers the following events:
Did this help?

GET

Get Member About


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 the "About" section content.

Permissions
Manage Members and Contacts - all permissions
Read Members and Contacts - all read permissions
Manage Members
Read Members
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/members/v2/abouts/{id}

Path Params
idstringRequired

ID of the "About" section content to retrieve.

Response Object
memberAboutMemberAbout

The retrieved "About" section content.

Get the Member "About" Section Content
Request
cURL
curl -X GET \ https://www.wixapis.com/members/v2/abouts/e901b292-70f0-4a20-8aaf-e06cd5dc5ca2 \ -H 'Authorization: <AUTH>'
Response
JSON
{ "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!" } } ] } ] } } }
Did this help?

DELETE

Delete Member About


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 the "About" section content.

Permissions
SCOPE.DC-MEMBERS.MANAGE-ABOUT
Learn more about app permissions.
Endpoint
DELETE
https://www.wixapis.com/members/v2/abouts/{id}

Path Params
idstringRequired

ID of the "About" section content to delete.

Response Object
Returns an empty object.
Delete the "Member" About Section Content
Request
cURL
curl -X DELETE \ https://www.wixapis.com/members/v2/abouts/e901b292-70f0-4a20-8aaf-e06cd5dc5ca2 \ -H 'Authorization: <AUTH>'
Response
JSON
{}
Event TriggersThis method triggers the following events:
Did this help?

GET

Get My Member About


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 the "About" section content of a currently logged in member.

Note: This method requires visitor or member authentication.

Permissions
Manage Members and Contacts - all permissions
Read Members and Contacts - all read permissions
Manage Members
Read Members
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/members/v2/abouts/my

Request
This endpoint does not take any parameters.
Response Object
memberAboutMemberAbout

The "About" section content of a currently logged in member.

Get My Member "About" Section Content
Request
cURL
curl -X GET \ https://www.wixapis.com/members/v2/abouts/my \ -H 'Authorization: <AUTH>'
Response
JSON
{ "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!" } } ] } ] } } }
Did this help?

POST

Query Member Abouts


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 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 order
  • paging.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

Permissions
Manage Members and Contacts - all permissions
Read Members and Contacts - all read permissions
Manage Members
Read Members
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/members/v2/abouts/query

Body Params
queryQuery

Query options. See API Query Language for more details.

Response Object
memberAboutsArray <MemberAbout>

The retrieved content from the "About" sections.


metadataMetadata

Metadata for the paginated results.

Query Member "About" Sections Content
Request
cURL
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" } } }'
Response
JSON
{ "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 } }
Did this help?

Member About 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 the "About" section content is created.

Permissions
Manage Members and Contacts - all permissions
Read Members and Contacts - all read permissions
Manage Members
Read Members
Learn more about app permissions.
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.about.v2.member_about.


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.


createdEventCreatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "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 } } }

MemberAboutCreated
JSON
{ "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!" } } ] } ] } } } } }
Did this help?

Member About 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 the "About" section content is deleted.

Permissions
Manage Members and Contacts - all permissions
Read Members and Contacts - all read permissions
Manage Members
Read Members
Learn more about app permissions.
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.about.v2.member_about.


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.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "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 } } }

MemberAboutDeleted
JSON
{ "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 }
Did this help?

Member About 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 the "About" section content is updated.

Permissions
Manage Members and Contacts - all permissions
Read Members and Contacts - all read permissions
Manage Members
Read Members
Learn more about app permissions.
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.about.v2.member_about.


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.


updatedEventUpdatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "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 } } }

MemberAboutUpdated
JSON
{ "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!" } } ] } ] } } } } }
Did this help?