group.md

description
Detailed technical description of the Group API call.

Group

The group call allows you to link an identified user with a group, such as a company, organization, or an account. It also lets you record any custom traits associated with that group, such as the name of the company, the number of employees, etc.

{% hint style="info" %} An identified user can be in more than one group. {% endhint %}

Sample Payload

A sample payload for the group event after removing the common fields mentioned in the Common Fields section is as shown:

{
  "type": "group",
  "groupId": "12345",
  "traits": {
    "name": "MyGroup",
    "industry": "IT",
    "employees": 450,
    "plan": "basic"
  }
}

The corresponding event that generates the above payload via the JavaScript SDK is as shown:

rudderanalytics.group("12345", {
  name: "MyGroup",
  industry: "IT",
  employees: 450,
  plan: "basic"
});

Group Fields

The group call has the following fields in addition to the Common Fields:

Field	Type	Presence	Description
groupId	String	Required	Your group's unique identifier which lets you identify the group in your database.
traits	Object	Optional	Includes the traits of the group such as name, email, employees, etc. For more more information, check the Traits section below.

Traits

Traits are bits of information included in an group call that add more context to the group. Some example of traits include the number of employees in the group, name of the industry the group is a part of, or the website of the group.

RudderStack has some reserved traits that it handles in special ways. These are listed in the table below:

Trait	Type	Description
id	String	The group's unique ID.
name	String	The group name.
email	String	The group's email address.
phone	String	Phone number associated with the group
address	Object	The group's street address. This can optionally contain either / all of the following fields: city country postalCode state street
industry	String	The name of the industry that the group is a part of.
createdAt	Date	Date of the group's account creation. We recommend using the ISO-8601 date string format.
description	String	The group's description.
employees	String	Number of the employees in the group. This is typically used for companies.
plan	String	The plan that the group is subscribed to.
website	String	The group's website.
avatar	String	URL of the group's avatar image.

Contact Us

For more information on any of the sections covered in this doc, you can contact us or start a conversation on our Slack channel.