Group Object

Group represents a community group.
Groups are tied to your community and community may have as many groups as limited by the community subscription plan.

Groups are ordered in a hierarchy so for some groups you will see a parent id property.
The hierarchy of the groups is structured in a way that the parent group will always contain the members of the child groups, Therefor when you add a member to a child group it automatically adds him to its parent groups. The same applies when you remove a member from a parent group, it automatically removes him from the child groups.

Each group has an array of fields that the admin may define in order to collect more data from the members. The basic fields are: First Name, Last Name and Email.
All the fields that are defined for a certain group will be inherited to the children group.
meaning that if an admin of a parent group creates a field, the field will automatically be propagated to the sub-groups and the removal of this field will be possible only from the parent group that originated this field.

The API may access all of your community groups and their data.

📘

For now we only support group view and not creation functionality.
Please contact your customer success manager with any questions or comments.

Group Object

JSON

DEFINITION
{
    "id" : {Numeric},
    "name" : {Text},
	  "email":{Text},
		"logo": {
      url:{Text}
      small_thumb:{Text},
		  mini_thumb:{Text},
  		thumb:{Text}
    }  		
    "fields": [
      {
        "id":{Numeric}
        "name":{Text}
      	...
      },
      ...
    ]
		...
}

Name	Type	Definition
id	Numeric	This is a unique identifier associated to each of your groups.
name	Text	This is the group name. limited to 255 chars.
email	Text	This is the group email address. by sending a message to this address users can post directly to the group without the need to login.
parent_group	Numeric	This is a unique identifier associated with a parent group.
logo	Object	The group logo image url
created_at	Numeric	The time this object was created, in UTC milliseconds past the epoch. This field is automatically updated by writing queries and not directly editable.
update_at	Numeric	The time this object was last modified, in UTC milliseconds past the epoch. This field is automatically updated by writing queries and not directly editable.
fields	Array[FieldDefinition]	An array of fields