Group Object

Properties
idstringRead-onlyformat GUID
Group ID.

slugstringminLength 1maxLength 100
A unique part of a group's URL, for example https:/example.com/groups/slug.

privacyLevelstring
4 enum supported values:
UNKNOWNPUBLICPRIVATESECRET
Deprecated. Use privacyStatus instead. This property will be removed on June 30, 2022.

privacyStatusstring
4 enum supported values:
UNKNOWNPUBLICPRIVATESECRET
Group privacy status.
  • PUBLIC - Anyone can see the group and its content. Anyone can join the group.
  • PRIVATE - Anyone can see the group, but only members can see its content. New member must submit a Join Group Request.
  • SECRET - Only admins and members can see the group. New members can only be added by other members.

titlestringmaxLength 100
Deprecated. Use name instead. This property will be removed on June 30, 2022.

namestringmaxLength 100
Group name.

descriptionstringmaxLength 20480
Group description in DraftJS format.

teaserstringmaxLength 1000
Group teaser.

detailsobject
Deprecated. For details.logo, use coverImage instead. For details.membersTitle, memberTitle instead. This property will be removed on June 30, 2022.

memberTitlestringminLength 1maxLength 1000
What group members are called, for example Coworkers, Friends, or Students.

coverImageobject
Cover image. You cannot upload your own cover image.

settingsobject
Group specific settings. Available to the site owners under Admin Tools in the Business Manager.

membersCountintegerRead-onlyformat int32
Total count of current group members.

createdByobject
Deprecated. Use ownerId instead. This property will be removed on June 30, 2022.

ownerIdstringRead-only
Group owner.

createdDatestringRead-onlyformat date-time
Group creation date and time.

updatedDatestringRead-onlyformat date-time
Date and time of the latest group update.

recentActivityDatestringRead-onlyformat date-time
Deprecated. Use lastActivityDate instead. This property will be removed on June 30, 2022.

lastActivityDatestringRead-onlyformat date-time
Date and time of the most recent group activity, for example a post or comment.
Was this helpful?
Yes
No

GetList Groups

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 up to 100 groups.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Social Groups
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/social-groups/v2/groups

Was this helpful?
Yes
No

PostCreate Group

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

Notes:

  • The site owners may not allow members to create groups.
  • Specify a creatorId to set the group's creator.
  • The group's creator will automatically become an admin.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Social Groups
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/social-groups/v2/groups

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

PatchUpdate Group

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 a group.

Note:

  • Only admins can update a group.
  • When group.privacyLevel is updated from PRIVATE to PUBLIC, all pending group join requests are automatically approved.
  • When group.privacyLevel is updated from PRIVATE to SECRET, all pending group join requests are automatically rejected.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Social Groups
Learn more about permission scopes.
Endpoint
PATCH
https://www.wixapis.com/social-groups/v2/groups/{group.id}

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

GetGet Group

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Social Groups
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/social-groups/v2/groups/{groupId}

Was this helpful?
Yes
No

DeleteDelete Group

Developer Preview

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

Hides a group from the Group List or cancels group request.

Notes:

  • Only admins can delete a group.
  • The group will no longer be visible in the live site or the Wix business manager.
  • It is not possible to restore the group via the Update Group endpoint into the live site.
  • It is still possible to retrieve the group via the Get Group, List Groups and Query Groups endpoints.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Social Groups
Learn more about permission scopes.
Endpoint
DELETE
https://www.wixapis.com/social-groups/v2/groups/{groupId}

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

GetGet Group By 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.

Retrieves a group by slug.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Social Groups
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/social-groups/v2/groups/slugs/{slug}

Was this helpful?
Yes
No

PostQuery Groups

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 up to 100 groups, given the provided paging, filtering, and sorting.

Supported fields for filtering:

  • title

Supported fields for sorting:

  • title
  • createdDate
  • membersCount
  • recentActivityDate

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Social Groups
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/social-groups/v2/groups/query

Was this helpful?
Yes
No

Group 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 group is created.

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.social_groups.v2.group.

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

Group 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 group is updated. See payload for more information about the specific trigger.

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.social_groups.v2.group.

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

Group Cover Changed

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 group's logo is changed.

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.social_groups.v2.group.

slugstring
Event name. Expected group_cover_changed.

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.

actionEventobject
Event information.

Was this helpful?
Yes
No

Group Description Changed

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 group's description is changed.

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.social_groups.v2.group.

slugstring
Event name. Expected group_description_changed.

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.

actionEventobject
Event information.

Was this helpful?
Yes
No

Group 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 group is deleted.

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.social_groups.v2.group.

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