Group Role Object
Attributes
valuestring
3 supported values:
UNKNOWN_ROLEMEMBERADMIN
Member's role.
  • MEMBER - Regular group member.
  • ADMIN - Group administrator.
Was this helpful?
Yes
No
PostAssign Role
Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Assigns a specific role to members.

Notes:

  • Only admins can assign roles.
  • You cannot create new members via this endpoint.

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/groups/{groupId}/roles/assign

Event Triggers

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

Unassigns a role from members.

Notes:

  • Only admins can unassign roles.
  • You cannot remove members via this endpoint.

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/groups/{groupId}/roles/unassign

Event Triggers

This method triggers the following events:
Was this helpful?
Yes
No
Role Assigned To Group Member
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 role is assigned to an existing member.

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_role.
slugstring
Event name. Expected assigned.
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
Role Unassigned From Group Member
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 role is removed from a member.

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_role.
slugstring
Event name. Expected unassigned.
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