--- schema_version: "1" id: a6b2bb649a5efd88995f295ad0ebd65f0fcea5ae8b4beb865bedd128c6aa9d59 title: Swarm collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_swarm.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_swarm.htm source_site: developer.salesforce.com content_type: documentation content_hash: 1dbc472f829c750eb72d7cd0ea12c29190782600d406e6bbffb138beb6d5653c description: Represents a team of agents, Salesforce users, or Slack users in a Slack channel or thread dedicated to solving a problem. This problem can be related to a support case, incident, sales opportunity, or change request. This object is available in API version 55.0 and later. --- # Swarm Represents a team of agents, Salesforce users, or Slack users in a Slack channel or thread dedicated to solving a problem. This problem can be related to a support case, incident, sales opportunity, or change request. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules To access this object for swarming in Salesforce, enable the Run Flows and Service Cloud User user permissions. For swarming in Slack, connect Salesforce to Slack and enable the Run Flows and Slack Service User user permissions. ## Fields | Field | Details | | --- | --- | | CollaborationRoomId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the collaboration room. This field is a relationship field. Relationship Name CollaborationRoom Relationship Type Lookup Refers To CollaborationRoom | | CollaborationTool | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Tool used for swarming. Possible values are: - None - Slack The default value is None. | | CollaborationUrl | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description URL of the Slack channel or thread. | | EndedDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date and time the swarm ended. | | HelpNeeded | Type textarea Properties Create, Nillable, Update Description Short description of the problem that the swarm is trying to solve. | | IsDedicatedChannel | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates if the swarm is happening in a dedicated channel (true) or in an existing channel (false). The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp when the current user last accessed this record, a record related to this record, or a list view. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description Timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it. | | MessageKey | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Slack thread or message. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the swarm. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the swarm owner. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | RelatedRecordId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the record the swarm’s problem is related to. The record can be of, for example, a case, incident, sales opportunity, or change request. This field is a polymorphic relationship field. Relationship Name RelatedRecord Relationship Type Lookup Refers To Account, Case, ChangeRequest, Incident, Opportunity, Problem, User | | StartedDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date and time the swarm started. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Status of the swarm. Possible values are: - Closed - In Progress - New - Waiting (Custom) The default value is New. | | UsageType | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Type of swarm. Possible values are: - CareMgmt—Care Coordination - DealRoom—Sales Channel - PartnerChannel—Partner Account Channel - Swarming The default value is Swarming. | ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. [SwarmFeed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [SwarmHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [SwarmOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [SwarmShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object.