Group

Represents a set of Users.

Supported Calls

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

Special Access Rules

Customer Portal users cannot access this object.

Fields

Field Field Type Field Properties Description
Email email Create

Filter

Nillable

Update

Email address for a group of type Case. Applies only for a case queue.
Name string Create

Filter

idLookup

Update

Required. Name of the group.
OwnerId reference Filter ID of the user who owns the group.
RelatedId reference Filter

Nillable

For Groups of type “Role,” the ID of the associated UserRole. Read-only.
Type picklist Create

Filter

Restricted picklist

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 PRM (Partner Relationship Management) Portal is enabled for the organization, in which case the type can be Regular or PRMOrganization.
  • Role—Public Group that includes all of the Users in a particular UserRole.
  • RoleAndSubordinates—Public Group that includes all of the Users in a particular UserRole and all of the Users in UserRoles below that UserRole.
  • Organization—Public Group that includes all of the Users 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 PRM feature enabled.
  • Queue—Public Group that includes all of the User who are members of a queue.
  • Territory—Public Group that includes all of the Users in an organization that has the territory feature enabled.
  • TerritoryAndSubordinates—Public Group that includes all of the Users in a particular UserRole and all of the Users in UserRoles below that UserRole.
Only Regular, Case, and Lead can be used when creating a group. The other values are reserved for salesforce.com use.

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 UserRoles. In versions before 13.0, such sharing would prevent the record from being deleted.
See Also:
GroupMember
Standard and Custom Object Basics
© Copyright 2000-2008 salesforce.com, inc. All rights reserved.
Various trademarks held by their respective owners.