Group

Groups are sets of users. They can contain individual users, other groups, the users in a particular role or territory, or the users in a particular role or territory plus all of the users below that role or territory in the hierarchy.

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

Special Access Rules

Customer Portal users can’t access this object.

Fields

Field	Details
DefaultDivision	Type picklist Properties Filter, Group, Restricted picklist, Sort Description This record’s default division. Only applicable if divisions are enabled for your organization.
DeveloperName	Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your organization. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object's name in a managed package and the changes are reflected in a subscriber's organization. Label is API Name.
DoesIncludeBosses	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the managers have access (`true`) or do not have access (`false`) to records shared with members of the group. This field is only available for public groups. This field is available in API version 18.0 and later.
DoesSendEmailToMembers	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the email is sent (`true`) or not sent (`false`) to the group members. The email is sent to queue members as well.
Email	Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address for a group of type Case. Applies only for a case queue.
Name	Type string Properties Create, Filter, Group, Sort, Update Description Required. Name of the group.
OwnerId	Type reference Properties Filter, Group, Sort Description ID of the user who owns the group.
RelatedId	Type reference Properties Filter, Group, Nillable, Sort Description For Groups of type “Role,” the ID of the associated UserRole.
Type	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Required. Type of the Group. One of the following values: `Regular`—Standard public Group. When you `create()` a Group, its type must be `Regular`, unless a partner portal is enabled for the organization, in which case the type can be `Regular` or `PRMOrganization`. `Role`—Public Group that includes all of the User records in a particular UserRole. `RoleAndSubordinates`—Public Group that includes all of the User records in a particular UserRole and all of the User records in any subordinateUserRole . `Organization`—Public Group that includes all of the User records in the organization. This Group is read-only. `Case`—Public group of users, members of a queue that can own a Case. `Lead`—Public group of users, members of a queue that can own a Lead. `PRMOrganization`—Public Group that includes all of the partners in an organization that has the partner portal feature enabled. `Queue`—Public Group that includes all of the User records that are members of a queue. `Territory`—Public Group that includes all of the User records in an organization that has the territory feature enabled. `TerritoryAndSubordinates`—Public Group that includes all of the User records in a particular UserRole and all of the User records in any subordinateUserRole. `Collaboration`—Chatter group. Only `Regular`, `Case`, and `Lead` can be used when creating a group. The other values are reserved.

Usage

Unlike users, this object can be deleted. Any User can access this object—no special permissions are needed.

Only public groups are accessible via the API. Personal groups are not available.

Note

In API version 13.0 and later, if you delete a public Group, it will be deleted even if it has been used in sharing, consistent with the behavior for UserRole. In versions before 13.0, such sharing prevents the record from being deleted.