Groups

Group Identification

A group represents each company or organization that groups your users.

You simply need to call the ‘group’ function when a new user is invited to a company or when they create one.

Each group must have a unique identifier.

Information Stored During Identification

Told has reserved some traits that carry semantic meaning for groups and handles them in special ways. You should only use reserved traits for their intended meaning.

TRAIT	TYPE	DESCRIPTION
id	String	Unique ID in your database for a group.
name	String	Name of the group.
createdAt	Date	Date when the group’s account was first created. Segment recommends ISO-8601 date strings.
employees	String	Number of employees in the group, typically used for companies.
plan	String	The plan the group is currently on.
website	String	Website of the group.
phone	String	Phone number of the group.
email	String	Email address of the group.
address	Object	Street address of the group. This should be a dictionary containing optional city, country, postalCode, state, or street.
avatar	String	URL to an avatar image for the group.
description	String	Description of the group, like their company bio.
industry	String	The industry the group is part of, or the industry the user works in.

---

Import

You can import your groups from your database in JSON or CSV format.

Each data entry must include a mandatory id field.

When importing groups, you can add a users field, which contains a list of user IDs associated with the group.

If the passed user does not exist, they will be created.