Group Info Object


A group is a set of site members that share access to site resources, such as members-only pages. The site's dashboard calls groups member roles. Site owners create roles in the dashboard, and apps create their own, such as Wix Pricing Plans, which creates a group for each pricing plan. A member gets access to a resource through the groups they belong to.

Properties
colorstring

Role color, as defined in the site's Member Permissions page.

One of:

  • "DARK_BLUE"
  • "LIGHT_BLUE"
  • "TEAL"
  • "LIGHT_GREEN"
  • "YELLOW"
  • "ORANGE"
  • "RED"
  • "VIOLET"
  • "PURPLE"

createdDatestringRead-onlyformat date-time

Date and time the role was created.


creationDatestringRead-onlydeprecated - use createdDate insteadformat date-time

Deprecated. Use created_date instead.


descriptionstringmaxLength 1500

Role description, if defined in the site's dashboard.


idstringRead-onlyformat GUID

Role ID.


titlestringmaxLength 50

Role name as defined in the site's Member Permissions page or one of "Admin" or "Member".


typestringmaxLength 50

Role type, set by the app that created the role, for example "plan" for roles created by Wix Pricing Plans. Empty for roles created on the site.

Did this help?