Group Request Object
Attributes
idstringRead-onlyformat GUID
Group request ID
groupobject
Group requested for creation.
statusstring
6 supported values:
UNKNOWN_STATUSPENDINGAPPROVEDREJECTEDCANCELLEDCANCELED
Status of group request.
  • PENDING - Pending group request.
  • APPROVED - Approved group request.
  • REJECTED - Rejected group request.
  • CANCELED - Canceled group request.
requestDetailsobject
Group request details.
Was this helpful?
Yes
No
PostApprove Group Requests
Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Approves Group Requests. Only admins can approve Group Requests.

Permission Scopes

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

Syntax

POST
https://www.wixapis.com/social-groups/v2/group-requests/approve

Event Triggers

This method triggers the following events:
Was this helpful?
Yes
No
PostReject Group Requests
Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Rejects Group Requests. Only admins can reject Group Requests.

Permission Scopes

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

Syntax

POST
https://www.wixapis.com/social-groups/v2/group-requests/reject

Event Triggers

This method triggers the following events:
Was this helpful?
Yes
No
GetList Group Requests
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 group requests across the site.

Permission Scopes

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

Syntax

GET
https://www.wixapis.com/social-groups/v2/group-requests
Was this helpful?
Yes
No
PostQuery Group Requests
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 groups requests across the site.

Supported fields for filtering:

  • status

Supported fields for sorting:

  • createdDate

Permission Scopes

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

Syntax

POST
https://www.wixapis.com/social-groups/v2/group-requests/query
Was this helpful?
Yes
No
Group Request Approved
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 Request is approved.

Permissions

SOCIAL-GROUPS.MANAGE
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
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_request.
slugstring
Event name. Expected approved.
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 Request Rejected
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 Request is rejected.

Permissions

SOCIAL-GROUPS.MANAGE
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
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_request.
slugstring
Event name. Expected rejected.
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